duarte64 / activities_restapi

Creating my first REST API with NodeJS, Express and Mongoose.

Activities Register REST Api

This is a project made for study purposes, to create my first CRUD and RestAPI in NodeJS, using Express and MongoDB.

✅ Features

• Basic User Features.
  • Insert all his basic informations, like your name, email and age.
  • Save profile and banner images, having a visual reference of the user.
  • List all users of the platform.
  • Delete a register.
  • Update a register.
  • Filter a user based in his name.
• Basic Activities Features.
  • Save a new activity with a description, date and an user associated within it.
  • List all activities of the platform.
  • Delete an activity.
  • Update an activity.
  • Filter the activities based in their descriptions.
  • Filter the activities based in the date or user.

⌨ How To Use

If you just wanna see how this project works, you can enter this url: https://activities-restapi.herokuapp.com/

To run in your PC, follow this steps:

• First of all, you will need to clone this repository.
• After that, you need to open the terminal inside the repository folder and run:

  $ npm install

• Lastly, create a .env file, this file requires this two enviroment variable:

  $ DB_CONNECTION='MONGODB ATLAS CLUSTER LINK'
  $ PORT='PORT TO RUN THE APPLICATION'

🛠 Tecnologies

The following tools where used in the development of this project:

• JavaScript ES6+
• NodeJS
  • Express
  • Mongoose
• MongoDB

💻 Autor

Gabriel Duarte 🧑‍💻

Made with ❤️

👋🏽 Get in touch!