Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Samet Demir committed Jun 3, 2024
1 parent 26c3176 commit dd18e5d
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Planny

Planny is a backend application developed in Go (Golang) that offers a simple features for students to effectively manage their daily plans. This project was created as part of the VatanSoft internship case, aiming to showcase the candidate's skills in backend development using Golang, GORM, MySQL, and the Echo web framework.
Planny is a backend application developed in Go (Golang) that offers a simple features for students to effectively
manage their daily plans. This project was created as part of the VatanSoft internship case, aiming to showcase the
candidate's skills in backend development using Golang, GORM, MySQL, and the Echo web framework.

## Technologies

- Golang
- GORM (Go Object-Relational Mapping)
- MySQL
Expand All @@ -17,6 +20,28 @@ Planny is a backend application developed in Go (Golang) that offers a simple fe
- **Conflict Checking**: Checking if there is another plan during the same date and time range when adding a new plan.
- **Student Registration and Information Update (Optional)**: Allow students to register and update their information.

## API Endpoints

All endpoints are prefixed with `/api/v1`. For more
info [Postman Workspace](https://www.postman.com/planetary-moon-654796/workspace/planny/collection/32427111-a2852ce0-76f1-46bf-93f0-0465dbded2f7?action=share&creator=32427111).

### Authentication

| Method | Path | Description |
|--------|---------------|---------------------------|
| POST | /register | Register a new student |
| POST | /login | Login an existing student |
| POST | /renew_access | Renew Access Token |

### Plans

| Method | Path | Description |
|--------|------------|----------------------------------|
| GET | /plans | Get all plans belongs to student |
| POST | /plans | Create a new plan |
| PATCH | /plans/:id | Update a plan |
| DELETE | /plans/:id | Delete a plan |

## License

This project is licensed under the [Apache License](./LICENSE).
Expand Down

0 comments on commit dd18e5d

Please sign in to comment.