https://github.com/jessestuart/next-ran
https://github.com/jessestuart/next-ran
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/jessestuart/next-ran
- Owner: jessestuart
- License: mit
- Created: 2017-11-12T05:21:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-12T05:22:24.000Z (over 8 years ago)
- Last Synced: 2025-03-12T23:33:51.630Z (over 1 year ago)
- Language: JavaScript
- Size: 299 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/Contributing.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: docs/Roadmap.md
Awesome Lists containing this project
README
### RAN : React . GraphQL . Next.js Boilerplate
[](https://greenkeeper.io/) [](#contributors) [](https://gitter.im/ran-boilerplate/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://travis-ci.org/Sly777/ran) []()
[](https://codeclimate.com/github/Sly777/ran) [](https://snyk.io/test/github/sly777/ran) [](https://www.npmjs.com/package/ran-boilerplate) [](https://github.com/prettier/prettier)
## Features
- ***Hot-Reload Ready for Dev***
- ***Next Generation JavaScript (ES6)***
- ***Offline Ready (Experimental!)***
- ***Next Generation CSS (CSS-in-JS)***
- ***Create New Page in a Second (with CLI)***
- ***SEO-Ready***
- ***Performance-first***
- ***Production Deployment Ready for Now, Digital Ocean and Heroku***
- ***Prettier and Eslint integrated***
## How to use
- Firstly, Clone the repo with this command.
```bash
git clone --depth=1 https://github.com/Sly777/ran.git RAN
cd RAN
yarn install && yarn run setup
```
- If you are not using Yarn, just run ```npm install && npm run setup``` instead ```yarn install && yarn run setup```
- After everything is finished, run ```yarn run dev``` (or ```npm run dev```)
And that's all!
#### Beta Version (Unstable)
Also, There is a ```beta``` version for new features & fixes that we are testing before release. To access beta;
```bash
git clone --depth=1 -b beta https://github.com/Sly777/ran.git RAN_beta
cd RAN_beta
yarn install && yarn run setup
```
It can be unstable, so that's why please use stable version if you are working on the project that is in production.
## Example
[Click here](https://ran-boilerplate.herokuapp.com/) to see example project to understand how RAN! works on production. I used [graph.cool](https://graph.cool/) service for GraphQL in the example.
## Commands
Best feature of RAN! is **CL commands**. You can just run one command to create page with route! [Click here](docs/Commands.md) to see details how It works on RAN!.
## Documentation
[Click here](docs) to see all details of RAN!
## FAQ
[Click here](docs/FAQ.md) for FAQ of RAN! If it doesn't solve your problem, feel free to open an issue on GitHub!
## License
This project is licensed under the MIT license, Copyright (c) 2017 Ilker Guller. For more information see [LICENSE.md](LICENSE.md).
## Contributing
Please read [Contributing doc](docs/Contributing.md) for details on our code of conduct, and the process for submitting pull requests.
## Versioning
RAN! is using [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Sly777/ran/tags).
## Author
* **Ilker Guller** - [website](http://ilkerguller.com) / [twitter](https://twitter.com/the_bluescreen)
See also the list of [maintainers](MAINTAINERS.md) who participated in this project.
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
| [
Ilker Güller](http://ilkerguller.com)
[💻](https://github.com/sly777/ran/commits?author=Sly777 "Code") [📖](https://github.com/sly777/ran/commits?author=Sly777 "Documentation") [👀](#review-Sly777 "Reviewed Pull Requests") [📢](#talk-Sly777 "Talks") | [
bjornmelgaard](https://bitbucket.org/melgaardbjorn)
[💻](https://github.com/sly777/ran/commits?author=BjornMelgaard "Code") [💬](#question-BjornMelgaard "Answering Questions") | [
Asten Mies](https://github.com/astenmies)
[💻](https://github.com/sly777/ran/commits?author=astenmies "Code") |
| :---: | :---: | :---: |
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!