https://github.com/opauwlo/node-js-boilerplate-api
a template for create apis with nodejs
https://github.com/opauwlo/node-js-boilerplate-api
api js jwt mongodb-atlas node nodejs template
Last synced: about 2 months ago
JSON representation
a template for create apis with nodejs
- Host: GitHub
- URL: https://github.com/opauwlo/node-js-boilerplate-api
- Owner: opauwlo
- License: mit
- Created: 2021-09-10T18:36:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T11:43:39.000Z (over 3 years ago)
- Last Synced: 2025-05-16T07:09:19.840Z (about 1 year ago)
- Topics: api, js, jwt, mongodb-atlas, node, nodejs, template
- Language: JavaScript
- Homepage:
- Size: 899 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# a template for Node.js api's
[](https://opensource.org/licenses/MIT)
> 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:
- [x] 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](https://nodejs.org/en/) ``` and follow the instructions for your SO.```
* You have installed the classic stable: version of `Yarn`.
``` for install Yarn go to ``` [Yarn Classic Site](https://classic.yarnpkg.com/lang/en/) ``` and follow the instructions for your SO.```
* You have installed `GIT`.
``` for install GIT go to ``` [GIT Site](https://git-scm.com/) ``` 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
cd
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
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 `.
3. Make your changes and confirm then: `git commit -m ''`
4. send to original branch: `git push origin sipa / `
5. Create the pull request.
Alternatively, consult the GitHub documentation [how to create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## 🤝 Contributors
We thank the following people who contributed to this project:
## 😄 Be one of the contributors
