Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yanrodrigues205/cleancity-backend
This repository aims to address the problem of irregular waste disposal, which happens every day where I live, creating a platform connecting people who want to dispose of waste with those who make a living from reusing these materials. ♻️ 💚
https://github.com/yanrodrigues205/cleancity-backend
Last synced: 7 days ago
JSON representation
This repository aims to address the problem of irregular waste disposal, which happens every day where I live, creating a platform connecting people who want to dispose of waste with those who make a living from reusing these materials. ♻️ 💚
- Host: GitHub
- URL: https://github.com/yanrodrigues205/cleancity-backend
- Owner: yanrodrigues205
- License: mit
- Created: 2024-04-25T18:09:37.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T03:15:36.000Z (4 months ago)
- Last Synced: 2024-09-15T10:05:34.926Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 202 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CleanCity-BackEnd
This repository was created to be the back-end of an application focused on meeting some of the objectives of the UN (United Nations Organization), in addition, we saw a current problem in our community, the irregular disposal of garbage, with this Clean City appears, focusing on helping people who depend on collecting recyclable waste with people who depend on it to live!
💻 Technologies
- list of all technologies you used
- Typescript
- MySQL
- Prisma
- NodeJS
- Docker
🚀 Getting started
Here you describe how to run your project locally
Prerequisites
Here you list all prerequisites necessary for running your project. For example:
- [NodeJS](https://nodejs.org/en)
- [Git](https://git-scm.com/)
- [Docker](https://www.docker.com/)
Cloning
How to clone your project
```bash
git clone https://github.com/yanrodrigues205/CleanCity-BackEnd.git
```
Config .env variables
Use the `.env.example` as reference to create your configuration file `.env` with your credentials
```yaml
# Database settings
DATABASE_USER='root'
DATABASE_PASSWORD='56c46fad85a799276c99793d4543a330'
DATABASE_NAME='clean_city'
DATABASE_HOST='database'
DATABASE_PORT=3306
DATABASE_URL="mysql://${DATABASE_USER}:${DATABASE_PASSWORD}@${DATABASE_HOST}/${DATABASE_NAME}"
# Server settings
SERVER_PORT=4000
PHP_MY_ADMIN_PORT=8000
SERVER_MESSAGE="RODANDO"
```
Starting
How to start your project
```bash
cd CleanCity-BackEnd
docker-compose up
```
📍 API Endpoints
Here you can list the main routes of your API, and what are their expected request bodies.
| route | description
|----------------------|-----------------------------------------------------
| GET /authenticate | retrieves user info see [response details](#get-auth-detail)
| POST /authenticate | authenticate user into the api see [request details](#post-auth-detail)
GET /authenticate
**RESPONSE**
```json
{
"name": "Tester 1",
"age": 18,
"email": "[email protected]"
}
```
POST /authenticate
**REQUEST**
```json
{
"username": "tester",
"password": "tester"
}
```
**RESPONSE**
```json
{
"token": "OwoMRHsaQwyAgVoc3OXmL1JhMVUYXGGBbCTK0GBgiYitwQwjf0gVoBmkbuyy0pSi"
}
```
🤝 Collaborators
Special thank you for all people that contributed for this project.
📫 Contribute
Here you will explain how other developers can contribute to your project. For example, explaining how can create their branches, which patterns to follow and how to open an pull request
1. `git clone https://github.com/yanrodrigues205/CleanCity-BackEnd.git`
2. `git checkout -b feature/NAME`
3. Follow commit patterns
4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!
