https://github.com/gabriellefoliv/planner-backend
Developed during NLW Journey by Rocketseat. A trip planner where you can create new trips, invite friends and send confirmation emails.
https://github.com/gabriellefoliv/planner-backend
nodejs prisma sqlite typescript
Last synced: 2 months ago
JSON representation
Developed during NLW Journey by Rocketseat. A trip planner where you can create new trips, invite friends and send confirmation emails.
- Host: GitHub
- URL: https://github.com/gabriellefoliv/planner-backend
- Owner: gabriellefoliv
- Created: 2024-07-10T14:21:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-11T14:33:05.000Z (almost 2 years ago)
- Last Synced: 2025-10-30T10:42:45.251Z (8 months ago)
- Topics: nodejs, prisma, sqlite, typescript
- Language: TypeScript
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
[JAVASCRIPT__BADGE]: https://img.shields.io/badge/Javascript-000?style=for-the-badge&logo=javascript
[TYPESCRIPT__BADGE]: https://img.shields.io/badge/typescript-D4FAFF?style=for-the-badge&logo=typescript
[EXPRESS__BADGE]: https://img.shields.io/badge/express-005CFE?style=for-the-badge&logo=express
[VUE__BADGE]: https://img.shields.io/badge/VueJS-fff?style=for-the-badge&logo=vue
[NEST__BADGE]: https://img.shields.io/badge/nest-7026b9?style=for-the-badge&logo=nest
[GRAPHQL__BADGE]: https://img.shields.io/badge/GraphQL-e10098?style=for-the-badge&logo=graphql
[JAVA_BADGE]: https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white
[SPRING_BADGE]: https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white
[MONGO_BADGE]: https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white
[AWS_BADGE]: https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white
Plann.er API 💻
![typescript][TYPESCRIPT__BADGE]
Getting Started •
API Endpoints •
Collaborators •
Contribute
i
A trip planner where you can create new trips, invite friends and send confirmation emails.
🚀 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://github.com/)
- [Git 2](https://github.com)
Cloning
How to clone your project
```bash
git clone your-project-url-in-github
```
Environment Variables
Use the `application.properties.example` as reference to create your configuration file `application.properties` with your AWS Credentials
```yaml
aws.region=us-east-1
aws.accessKeyId={YOUR_AWS_KEY_ID}
aws.secretKey={YOUR_AWS_SECRET}
```
Starting
How to start your project
```bash
cd project-name
npm some-command-to-run
```
📍 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": "Fernanda Kipper",
"age": 20,
"email": "her-email@gmail.com"
}
```
POST /authenticate
**REQUEST**
```json
{
"username": "fernandakipper",
"password": "4444444"
}
```
**RESPONSE**
```json
{
"token": "OwoMRHsaQwyAgVoc3OXmL1JhMVUYXGGBbCTK0GBgiYitwQwjf0gVoBmkbuyy0pSi"
}
```