opauwlo / node-js-boilerplate-api

a template for create apis with nodejs

a template for Node.js api's

this is a simple template for create apis with nodejs using mongo and JwT auth

📦template
 ┣ 📂__tests__
 ┃ ┣ 📂integration
 ┃ ┃ ┗ 📜main.spec.js
 ┃ ┗ 📂unit
 ┣ 📂src
 ┃ ┣ 📂configs
 ┃ ┃ ┣ 📜database.config.js
 ┃ ┃ ┗ 📜server.config.js
 ┃ ┣ 📂controllers
 ┃ ┃ ┣ 📜delete.controller.js
 ┃ ┃ ┣ 📜get.controller.js
 ┃ ┃ ┣ 📜post.controller.js
 ┃ ┃ ┗ 📜put.controller.js
 ┃ ┣ 📂middlewares
 ┃ ┃ ┗ 📜verifyJwtToken.js
 ┃ ┣ 📂models
 ┃ ┃ ┗ 📜exemple.js
 ┃ ┣ 📂routes
 ┃ ┃ ┗ 📜routes.js
 ┃ ┣ 📂utils
 ┃ ┃ ┗ 📜verifyIsAdmin.js
 ┃ ┗ 📜main.js
 ┣ 📜.editorconfig
 ┣ 📜.eslintrc.json
 ┣ 📜.gitignore
 ┣ 📜ex.env
 ┣ 📜package.json
 ┗ 📜yarn.lock

Adjustments and improvements

The project is still under development and future updates will focus on the following tasks:

• Add Restfull Crud template
• [] Add a login system template
• [] Add a auth JWT template

💻 Prerequisites

Before starting, make sure you have met the following requirements:

• You have installed the latest version of Node.JS.

  for install node.js go to Node.js Site and follow the instructions for your SO.

• You have installed the classic stable: version of Yarn.

  for install Yarn go to Yarn Classic Site and follow the instructions for your SO.

• You have installed GIT.

  for install GIT go to GIT Site and follow the instructions for your SO.

• You have read this readme.md.

🚀 Installing (cloning) this template

To clone, follow these steps:

Linux, macOS and windows:

git clone https://github.com/opauwlo/node-js-boilerplate-api.git <your project name>
cd <your project name>
yarn i

🚀 also you can use sipas, for installing s'ipas to use this template:

Linux, macOS and windows:

npm i -g sipas

☕ Using with s'ipas

To use s'ipas, follow these steps after install:

$ sipas

---

cd  <your project name>
yarn i

🧪 Tests

We are using jest to perform the tests, to test the tests (funny) just run yarn test inside your project

📫 Contributing to s'ipa

Para contribuir com s'ipa, siga estas etapas:

1. Fork this repository.
2. Create a branch: git checkout -b <name_branch>.
3. Make your changes and confirm then: git commit -m '<message_commit>'
4. send to original branch: git push origin sipa / <local>
5. Create the pull request.

Alternatively, consult the GitHub documentation how to create a pull request.

🤝 Contributors

We thank the following people who contributed to this project:

opauwlo

😄 Be one of the contributors