Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rinaldilucas/node-user-api
Simple example of an user api using node.js, express.js and mongodb.
https://github.com/rinaldilucas/node-user-api
express expressjs mongodb mongoose node nodejs
Last synced: about 2 months ago
JSON representation
Simple example of an user api using node.js, express.js and mongodb.
- Host: GitHub
- URL: https://github.com/rinaldilucas/node-user-api
- Owner: rinaldilucas
- License: mit
- Created: 2022-04-06T00:29:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T23:55:35.000Z (about 1 year ago)
- Last Synced: 2023-10-25T00:28:30.764Z (about 1 year ago)
- Topics: express, expressjs, mongodb, mongoose, node, nodejs
- Language: JavaScript
- Homepage:
- Size: 39.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
User Api using Node.js
Api built with Node.js, Express.js and MongoDB
to jumpstart your studies.
Explore the docs »
Open
·
Donate
Table of Contents
## About The Project
A very simple node project to help people looking for API examples using express.js and mongodb. If this repository helped you, don't hesitate to leave a star!
### Built With
This section shows what technologies are used in this particular project.
- [MongoDB](https://www.mongodb.com/)
- [Express.js](https://expressjs.com/)
- [NodeJS](https://nodejs.org/en/)
## Getting Started
After cloning the project, you need to do a few things to be able to run it.
### Prerequisites
You need to have the following requirements:
- mongodb (download here)
- node (download here)
- npm
```sh
npm install -g npm
```
- nodemon
```sh
npm install -g nodemon
```
### Installation
_Below is an example of how you can run the project._
1. Clone the repo
```sh
git clone https://github.com/rinaldilucas/node-api-example.git
```
2. Install NPM packages via npm
```sh
npm install
```
3. Create a database named usersdb
4. Create a collection named users (or import the `./db/users.json`)
5. Run the api in development mode
```js
npm run dev
6. Serve the api
```js
npm run build
```
7. Serve the api with production environments
```js
npm run build
```
## Usage
You can import the Postman routes via file `./db/postman-collection.json` and import the mongodb collection via file `./db/users.json`.
And below are the implemented routes. You can consult them in `user.routes.js` either.
```js
[GET] localhost:3000/api/users -> 'findAll'
[GET] localhost:3000/api/users/{id} -> 'findById'
[GET] localhost:3000/api/users/email/{email} -> 'findByEmail'
[GET] localhost:3000/api/users/username/{username} -> 'findByUsername'
[POST] localhost:3000/api/users -> 'create'
[UPDATE] localhost:3000/api/users -> 'update'
[DELETE] localhost:3000/api/users/{id} -> 'delete'
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
3. Commit your Changes (`git commit -m 'feat: add some amazing feature'`)
4. Push to the Branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.
## Contact
[](https://rinaldilucas.com)
[](https://github.com/rinaldilucas)
[](mailto:[email protected])
[](mailto:[email protected])
[](https://www.linkedin.com/in/rinaldilucas/)
[](https://t.me/rinaldilucas)
Project Link: [https://github.com/rinaldilucas/node-api-example](https://github.com/rinaldilucas/node-api-example)
## Donations
If you feel that this project has helped you in any way, whether it's attracting clients or teaching you about the technologies used, feel free to make a donation.
It helps me a lot to continue developing open source codes.
- Metamask (USDT):
```sh
0x16362DF7f963CeEBB2114B467B68F5A58972ee65
```
- PIX (BRL):
```sh
72140bc8-fadc-42f5-abb6-9c13cc80a59f
```
[contributors-shield]: https://img.shields.io/github/contributors/rinaldilucas/node-api-example.svg?style=for-the-badge
[contributors-url]: https://github.com/rinaldilucas/node-api-example/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/rinaldilucas/node-api-example.svg?style=for-the-badge
[forks-url]: https://github.com/rinaldilucas/node-api-example/network/members
[stars-shield]: https://img.shields.io/github/stars/rinaldilucas/node-api-example.svg?style=for-the-badge
[stars-url]: https://github.com/rinaldilucas/node-api-example/stargazers
[license-shield]: https://img.shields.io/github/license/rinaldilucas/node-api-example.svg?style=for-the-badge
[license-url]: https://github.com/rinaldilucas/node-api-example/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/rinaldilucas/
[product-screenshot]: sources/images/readme/screenshot.png