https://github.com/rafaelgoulartb/rest-api-mongo
📦 Basic RESTful API with Node.js, Express & TypeScript
https://github.com/rafaelgoulartb/rest-api-mongo
express mongodb mongoose nodejs rest-api
Last synced: 3 months ago
JSON representation
📦 Basic RESTful API with Node.js, Express & TypeScript
- Host: GitHub
- URL: https://github.com/rafaelgoulartb/rest-api-mongo
- Owner: RafaelGoulartB
- License: mit
- Created: 2021-07-03T15:59:53.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-03T16:12:23.000Z (almost 5 years ago)
- Last Synced: 2025-02-22T04:41:11.438Z (over 1 year ago)
- Topics: express, mongodb, mongoose, nodejs, rest-api
- Homepage:
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Rest API with Mongo
> :package: Basic RESTful API with Node.js, Express & TypeScript.
# :pushpin: Table of Contents
* [Technologies](#computer-technologies)
* [Features](#rocket-features)
* [How to Run](#construction_worker-how-to-run)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :computer: Technologies
This project was made using the follow technologies:
* [NodeJS](https://nodejs.org/en/)
* [Express](https://expressjs.com/)
* [MongoDB](https://docs.mongodb.com/)
# :rocket: Features
* User registration
* Post CRUD
# :construction_worker: How to run
```bash
# Clone Repository
$ git clone https://github.com/RafaelGoulartB/rest-api-mongo.git
```
### 📦 Run API
```bash
# Go to server folder
$ cd rest-api-mongo
# Install Dependencies
$ yarn install
# Run Aplication
$ yarn run dev
```
Access API at http://localhost:3333/
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the the [rest-api-mongo](https://github.com/RafaelGoulartB/rest-api-mongo/issues) repository. If you already found a solution to your problem, **i would love to review your pull request**!
# :tada: Contributing
First of all, thank you for being interested in helping out, your time is always appreciated in every way. :100:
Here's some tips:
* Check the [issues page](https://github.com/RafaelGoulartB/rest-api-mongo/issues) for already opened issues (or maybe even closed ones) that might already address your question/bug/feature request.
* Feature requests are welcomed! Provide some details on why it would be helpful for you and others, explain how you're using bull-board and if possible even some screenshots if you are willing to mock something!
Check out the [contributing](./CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Released in 2020 :closed_book: License
Made with love by [Rafael Goulart](https://github.com/RafaelGoulartB) 🚀.
This project is under the [MIT license](./LICENSE).
Give a ⭐️ if this project helped you!