- Prerequisites
- Getting Started
- Folder Structure
- Available Scripts
- Running Tests
- Deployment
- Built With
- Database/Storage
- Commit Message Guidelines
- Branch Management
- Versioning
- Authors
- Contributing
- License
- Acknowledgements
You’ll need to have Node 8.10.0 or later on your local development machine. You can use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects. Node.js. That's all you need.
node -v // v9.2.0Run server
npm install
npm devOpen a new terminal to run database
Run server
yarn
yarn devOpen a new terminal to run database
Run server
npm install
npm prodOpen a new terminal to run database
Run server
yarn
yarn prodOpen a new terminal to run database
express-mongo-boilerplate
├── README.md
├── LICENSE.md
├── tmp
├── node_modules
├── package.json
├── .gitignore
├── config
│ ├── .env.example
│ ├── .env.development
│ ├── .env.staging
│ ├── .env.production
│ └── env.js
├── src
│ ├── bin
│ ├── db
│ ├── routes
│ ├── controllers
│ ├── middlewares
│ ├── utils
│ └── app.js
└── index.js - Entry point
Preparing... Maybe like this
yarn testSo simple!
Actually, it's just a plan yet.
Will make new repository soon.
Will be prepared
Additional notes about how to deploy this on a live system will be added soon.
- Node.js - Used to build server.
Note: Planing to use
- AWS S3 - Amazon S3(Simple Storage Service) is an object storage service that offers nice scalability, data availability, security, and performance.
- Circle CI - Continuous Integration. (TODO)
- MongoDB - Widely used free to use NoSQL database.
- Docker - Containerizate software. (TODO)
Data will be stored in MongoDB. Can specify MongoDB URI in environment variable MONGODB_CONNECTION_URL This variable(MONGODB_CONNECTION_URL) is required to run the server Configuration can be found in ./src/db/index.js
S3 can be configured with 4 environment variables
AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_S3_BUCKET_NAME
I referred Google's Angular JS's contributor's commit message guidelines to format commit messages. This leads to more unified and readable messages helping further history lookups and even CI integrations.
By the way, this repository's commit messages format is not exactly same as the one suggested above.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
Samples: (even more samples)
docs(README): update README adding instruction on how to start docker on EC2
build(babel): Add babel preset-env
Add @babel/core, @babel/preset-env and register with @babel/register.
Entry point of the application is set to be bin/www_es6.js
Refer to the package.json file to fidn out more.
If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Should be one of the following:
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
- misc: Adding miscellaneous items
There's no specific recommendations for naming scope yet. Feel free to write your own scopes.
The subject contains a succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- do capitalize the first letter
- no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". If the commit derives changes from previous behavior, the body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to
I use git-flow to manage branches. For branch history, see the branches on this repository.
Anyone can freely contribute on this repository.
If you have questions, do not hesitate to contact.
I use SemVer for versioning. For the versions available, see the tags on this repository.
- jungdj - jungdj
This project is licensed under the MIT License - see the LICENSE.md file for details
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent