Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathiscode/reactify-boilerplate
A quickstart boilerplate using React & Restify
https://github.com/mathiscode/reactify-boilerplate
animatecss boilerplate bootstrap bootswatch font-awesome i18n mongodb nodejs react react-router redux restify
Last synced: 3 days ago
JSON representation
A quickstart boilerplate using React & Restify
- Host: GitHub
- URL: https://github.com/mathiscode/reactify-boilerplate
- Owner: mathiscode
- License: mit
- Created: 2018-11-12T03:01:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T05:26:45.000Z (2 months ago)
- Last Synced: 2024-10-23T07:50:22.957Z (2 months ago)
- Topics: animatecss, boilerplate, bootstrap, bootswatch, font-awesome, i18n, mongodb, nodejs, react, react-router, redux, restify
- Language: JavaScript
- Homepage: http://reactify-boilerplate.mathis.network
- Size: 6.45 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 174
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 
[](https://github.com/mathiscode/reactify-boilerplate/blob/master/LICENSE.md)
[](https://standardjs.com)
[](https://travis-ci.org/mathiscode/reactify-boilerplate)
[](https://github.com/mathiscode/reactify-boilerplate/issues)
[](https://github.com/mathiscode/reactify-boilerplate/compare)
> “This is what I have learned, Malenfant. This is how it is, how it was, how it came to be.”
>
> *― Stephen Baxter, Manifold: Time*
[](https://twitter.com/intent/tweet?text=Check%20out%20Reactify%20Boilerplate&url=https://github.com/mathiscode/reactify-boilerplate&hashtags=react,restify,nodejs,javascript,bootstrap,developers) *Help spread the word and share this project!*
[](http://reactify-boilerplate.mathis.network)
---
---
- [Why Reactify Boilerplate](#why-reactify-boilerplate)
- [Frontend: React](#frontend-react)
- [Backend: Restify](#backend-restify)
- [Installing](#installing)
- [Configuring](#configuring)
- [Customizing](#customizing)
- [Running the development environment](#running-the-development-environment)
- [Testing](#testing)
- [Building](#building)
- [Logging](#logging)
- [Log to file](#log-to-file)
- [Log to Logz.io](#log-to-logzio)
- [Log to Loggly](#log-to-loggly)
- [License](#license)
- [Donate](#donate)
- [Contributing](#contributing)
- [Contributors](#contributors)
---
## Why Reactify Boilerplate
Reinventing the wheel sucks. Reactify Boilerplate lets you get started with a solid foundation for new projects.
### Frontend: React
Reactify Boilerplate uses [React](https://reactjs.org) (via [Create React App](https://github.com/facebook/create-react-app)) as a frontend framework.
Includes:
- [Bootstrap 4](https://getbootstrap.com) (via [reactstrap](https://reactstrap.github.io/))
- [Bootswatch Themes](https://bootswatch.com)
- [React Router](https://reacttraining.com/react-router)
- [Redux](https://redux.js.org/)
- [React-Toastify](https://github.com/fkhadra/react-toastify)
- [FontAwesome](https://fontawesome.com)
- [Animate.css](https://daneden.github.io/animate.css)
- [Particles.js](https://github.com/VincentGarreau/particles.js)
- [Internationalization (via react-i18next)](https://react.i18next.com)
- Local & Google OAuth login/signup
### Backend: Restify
Reactify Boilerplate uses [Restify](http://restify.com) as a backend server.
Includes:
- [Mongoose](https://mongoosejs.com)
- [Internationalization (via i18n)](https://github.com/mashpie/i18n-node)
- User login/signup is already implemented for you
---
## Installing
For best results, you should have [Yarn](https://yarnpkg.com/en/docs/install) installed.
You'll probably want to [use this repository as a template](https://github.com/mathiscode/reactify-boilerplate/generate), then replace the clone URL and directory name below.
```sh
git clone https://github.com/mathiscode/reactify-boilerplate.git
cd reactify-boilerplate
yarn
```
## Configuring
```bash
cp .env.example .env
```
Edit `.env` or set environment variables for server configuration
Edit `client/src/config/site.js` for client configuration
Edit `client/src/config/keys.js` for client-side API keys (*eg. Google OAuth*)
## Customizing
Edit/add client components in `client/src/components`
Edit/add server routes in `server.js` (*look for the comment* `// Setup routes`)
`routes/users/index.js` has examples of how to include routes
See more guides in the [Wiki](https://github.com/mathiscode/reactify-boilerplate/wiki)
### Running the development environment
```bash
yarn dev # This will launch both the Restify server and the React development server.
```
## Testing
```bash
# Complete:
yarn test
# Individually:
yarn lint
yarn test-server
yarn test-client
```
## Building
Once you've made some changes to the client, run:
```bash
yarn build
```
This will bundle the React app and place it into the server's /public directory.
## Logging
Logs will output to the console if NODE_ENV is not `production`
### Log to file
In `.env` or your environment variables, set:
```INI
LOG_FILE=filename.log
ERROR_LOG_FILE=errors.log
```
### Log to [Logz.io](https://logz.io)
In `.env` or your environment variables, set:
```INI
USE_LOGZIO=true
LOGZIO_API_TOKEN=yourlogziotoken
```
### Log to [Loggly](https://loggly.com)
In `.env` or your environment variables, set:
```INI
USE_LOGGLY=true
LOGGLY_SUBDOMAIN=yourlogglysubdomain
LOGGLY_TOKEN=yourlogglytoken
LOGGLY_TAGS=mytag-1,mytag-2
```
*Note: you may get [a warning](https://github.com/loggly/winston-loggly-bulk/issues/45) about the loggly module; this can be safely ignored.*
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Donate
- [**Beerpay.io**](https://beerpay.io/mathiscode/reactify-boilerplate): https://beerpay.io/mathiscode/reactify-boilerplate
- **BTC**: 3722p31ydjezmzbcepCf29DQ8tvjoLUPVB
- **OR**: Donate some time by submitting a pull request!
## Contributing
Read the [Contribution Guide](https://github.com/mathiscode/reactify-boilerplate/blob/master/CONTRIBUTING.md)
## Contributors
- [J.R. Mathis (mathiscode)](https://github.com/mathiscode)
- See the full list of [contributors](https://github.com/mathiscode/reactify-boilerplate/graphs/contributors)