This is a RESTful API developed using NestJS, aiming help the NGO "Mãos Entrelaçadas";
The Mãos Entrelaçadas REST API is a final paper to Systems analysis and development course, aiming help the NGO "Mãos Entrelaçadas" collect funds, implements technology stronger and reach more people with this same technology. It utilizes the NestJS framework, a progressive Node.js framework for building efficient, reliable and scalable server-side applications.
The API offers the following resources:
- Auth: Login with user.
- Announcements: Management of announcements such as creating, listing, updating and deleting.
- Events: Managemet of events such as creating, listing, updating, deleting and sign an user to a specific event.
- Genders: Management of genders such as creating, listing and deleting.
- User: Management of users such as creating, listing, updating, deleting and get all events signed by the user.
Follow the instructions below to set up and run the project on your local environment:
- Clone this repository to your computer using the command:
git clone https://github.com/FernandoBrino/maos_entrelacadas.git- Access the project directory:
cd maos_entrelacadas- Install the project dependencies:
npm install- Run migrations:
npm run:migration- Start the development server:
npm start:dev- The server will be running locally at
http://localhost:3000.
After starting the server, you can use the API through Swagger, accessing _baseURL/api.
Contributions are welcome! If you find any issues, have suggestions, or want to add new features, feel free to open an issue or submit a pull request.
This project is licensed under the ISC License.
Created by Fernando Brino