Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Will413028 committed Feb 15, 2024
1 parent 1db73c8 commit 5dc6e95
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 5 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
# Attendance-System-fastapi

## Demo Link

https://attendance-system-frontend-5raarijksa-de.a.run.app/


## Features
- ### Database: using MySQL
- ### Authentication: using jsonwebtoken
- ### Testing: unit tests using pytest
- ### CI/CD: using GitHub Action and GCP


## API Endpoints
List of available routes:

**Auth routes**:\
`POST /login` - login

**User routes**:\
`GET /users` - get all users\
`PUT /users/:id` - update user

**Attendance routes**:\
`GET /attendances` - get all attendance\
`POST /attendances` - create an attendance\
`PUT /attendances/:id` - update attendance\
`GET /attendanceQRcode` - get attendance QRcode

**Holiday routes**:\
`POST /holidays` - create holiday\
`GET /holidays` - get all holiday


## How to run:

Run server

Expand Down
5 changes: 0 additions & 5 deletions main.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,6 @@ def get_settings():
return Settings()


@app.get('/')
def hello():
return {'message': 'Hello World'}


@app.get("/users/{id}", response_model=schemas.User)
def get_user_by_id(id: int, db: Session = Depends(get_db), current_user: dict = Depends(jwt.get_current_user)):
user = service.get_user_by_id(db, id)
Expand Down

0 comments on commit 5dc6e95

Please sign in to comment.