Skip to content

Doni-zete/North-Scheduling-Socrates

Repository files navigation

Classes Scheduling Rest API

Second challenge offered by the internship (Node.js) - AWS Cloud Context - Compass UOL. The challenge simulates a scenario in which this microservice will be used by people who wants to schedule classes with specialized professionals in their free time.

North Squad

Members:
Name: Asttryd Santos Pacheco
Name: Donizete Crisostomo Barbosa
Name: João Amim Mascarenhas Bonina
Name: Sebastião Leonardo Ribeiro Junior
Name: Pedro Henrique Mota

Compass E-mails:
Compass E-mail: [email protected]
Compass E-mail: [email protected]
Compass E-mail: [email protected]
Compass E-mail: [email protected]
Compass E-mail: [email protected]

Technologies

• TypeScript
• Node.js
• Express
• MongoDB
• Mongoose
• JWT (JSON Web Tokens)
• Jsonwebtoken
• Jsonwebtoken
• Express Validator
• Eslint
• HTTP Status Codes
• Express Router
• Cookies
• Swagger
• Jest

Functionalities

✅ Register, Login and Logout Instructors
✅ Register, Login and Logout Students
✅ Register, Login and Logout Admins
✅ Updates and Deletes Instructors, Students and Admins
✅ Only the account creator can update or delete his data besides the admins
✅ Instructor creates his availability
✅ Students creates appointments with an available instructor
✅ Students can upload TXT, DOCX and PDF files
✅ Unitary tests with JEST

Timeline

The project was divided into 2 stages each of two weeks and a repechage week. The stages are located in the branches:

release-step
release-step2
main

How to run Locally

To run the project locally, follow the steps below:

1 - Make sure you have Node.js and git installed on your machine. If not, download the node version compatible with your machine. And the one from git. (If you have to download git you will have to configure it to activate in the VS Code terminal)

2 - Copy the link provided in the <>Code button of this repository or get it here(https://github.com/Doni-zete/North-Scheduling-Socrates.git). Go to the Vs Code terminal and use the command git init to start a repository and then use the command git clone https://github.com/Doni-zete/North-Scheduling-Socrates.git.

3 - Change the current directory with the command cd

4 - Use the command npm install to install all required dependencies.

5 - Now rename the .env.example file to .env and add your connection string provided by mongoDB next to the front of MONGO_URL=

6 - Change to your database password and at "/?" enter the name of the database. 6 - Change to your database password and at "/?" enter the name of the database.

7 - Provide JWT_SECRET, JWT_LIFETIME and CREATE_ADMIN_KEY at .env file. The application port is already set to 3000.

8 - Use the command npm start in the VS Code terminal to start the program

9 - Open an application supporting the documentation of requests made by APIs called PostMan and follow the Swagger instructions.

10 - After the application is running the Swagger link will be http://localhost:3000/docs.

SMs and Instructors

Scrum Masters:

Instructors Contact:

References

Final post-run notes 📑

Notes
SoftSkills -
HardSkills -

Points of improvement presented:

  • [ ]
  • [ ]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •