ran-boilerplate
Version:
React . Apollo (GraphQL) . Next.js Toolkit
127 lines (74 loc) • 5.92 kB
Markdown
### RAN : React . GraphQL . Next.js Toolkit
[](https://opencollective.com/ran/) [](https://opencollective.com/ran/)
[](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) []()<br/>
[](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) [](https://github.com/Sly777/ran)
## 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 && yarn setup
```
- If you are not using Yarn, just run ```npm install && npm run setup``` instead of ```yarn && yarn setup```
- After everything is finished, run ```yarn dev``` (or ```npm run dev```)
And that's all!
## Start coding on browser! (via [Glitch](https://glitch.com))
Just click the button and then start to work with RAN!
[](https://glitch.com/edit/#!/import/github/Sly777/ran)
#### Clean Setup (without example pages & components)
```bash
git clone --depth=1 https://github.com/Sly777/ran.git RAN
cd RAN
yarn && yarn setup:clean
```
#### 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 && yarn 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.now.sh/) to see example project to understand how RAN! works on production. I used [graph.cool](https://graph.cool/) service for GraphQL and [now](https://zeit.co/now) for hosting 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](https://www.rantoolkit.com/) 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)
## Contributors
Thanks goes to these wonderful people:
<a href="graphs/contributors"><img src="https://opencollective.com/ran/contributors.svg?width=890" /></a>
### Backers
Thank you to all our backers! [[Become a backer](https://opencollective.com/ran#backer)]
<a href="https://opencollective.com/ran#backers" target="_blank"><img src="https://opencollective.com/ran/backers.svg?width=890"></a>
### Sponsors
Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/ran#sponsor))
<a href="https://opencollective.com/ran/sponsor/0/website" target="_blank"><img src="https://opencollective.com/ran/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/ran/sponsor/1/website" target="_blank"><img src="https://opencollective.com/ran/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/ran/sponsor/2/website" target="_blank"><img src="https://opencollective.com/ran/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/ran/sponsor/3/website" target="_blank"><img src="https://opencollective.com/ran/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/ran/sponsor/4/website" target="_blank"><img src="https://opencollective.com/ran/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/ran/sponsor/5/website" target="_blank"><img src="https://opencollective.com/ran/sponsor/5/avatar.svg"></a>