Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jfeigel/mongo-react-koa-node-starter
Opinionated Starter Kit featuring MongoDB, React, Koa, and Node
https://github.com/jfeigel/mongo-react-koa-node-starter
Last synced: about 6 hours ago
JSON representation
Opinionated Starter Kit featuring MongoDB, React, Koa, and Node
- Host: GitHub
- URL: https://github.com/jfeigel/mongo-react-koa-node-starter
- Owner: jfeigel
- License: gpl-3.0
- Created: 2020-03-23T20:40:47.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T19:38:44.000Z (almost 2 years ago)
- Last Synced: 2024-04-15T00:16:51.848Z (6 months ago)
- Language: JavaScript
- Size: 5.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
## Services
### `yarn run mongo`
Starts the MongoDB daemon process in a new screen.
*Note:*
If you wish to use a different folder to store the MongoDB data in, make sure this folder exists and add it as a option to the mongo script in the [package.json](package.json#L18) file.
e.g.
```JSON
...
"mongo": "screen -dmS mrkn-mongodb bash -c 'mongod -dbpath=/data",
...
```
### `yarn run redis`
Starts the Redis server in a new screen.
### `yarn run services`
Start the MongoDB daemon process and the Redis server in new screens.
## App
### `yarn run server`
Runs the server in development mode.
### `yarn run web`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### `yarn start`
Runs the app and server at the same time using [concurrently](https://github.com/kimmobrunfeldt/concurrently).
## Utilities
### `yarn run lint`
Runs eslint on all files.
See the config files [.eslintrc](.eslintrc) and [.eslintignore](.eslintignore) for the configuration values and [eslint](https://eslint.org/) for more information.
### `yarn test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
### `yarn run docs`
Build the documentation website with [JSDoc](https://jsdoc.app/).
See the JSDoc config file [jsdoc.conf.json](jsdoc.conf.json) for more information.
### `yarn run docs:server`
Starts a Python SimpleHTTP server and serves the `docs` folder.
Open [http://localhost:1337](http://localhost:1337) to view it in the browser.
*Note:*
You must have Python installed on your system.
### `yarn run docs:all`
Builds the documenation website and starts the Python SimpleHTTP server.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).