https://github.com/aaqyaar/telemedicine-api
Telemedicine API | Research Thesis Project
https://github.com/aaqyaar/telemedicine-api
Last synced: 3 months ago
JSON representation
Telemedicine API | Research Thesis Project
- Host: GitHub
- URL: https://github.com/aaqyaar/telemedicine-api
- Owner: aaqyaar
- Created: 2024-01-20T19:09:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-29T11:42:38.000Z (over 1 year ago)
- Last Synced: 2024-01-29T14:11:41.505Z (over 1 year ago)
- Language: Go
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Telemedicine App API
This is the API for the Telemedicine App. It is built using the Go programming language and the Fiber framework.
## Getting Started
To get started, follow the instructions below.
1. Clone the repository
```bash
git clone https://github.com/aaqyaar/telemedicine-api
```
2. Copy the `.env.example` file to `.env` and fill in the required values
```bash
cp .env.example .env
```
3. Install the dependencies using `go get .`
4. Run `go run .` to start the server
### Prerequisites
- [Go](https://golang.org/doc/install)
- [Docker](https://docs.docker.com/get-docker/) (optional)
## Built With
- [x] Go & Fiber
- [x] PostgreSQL
- [x] RabbitMQ
- [x] Redis (for caching)
## Authors
- **Abdi Zamed Mohamed** (Team Lead)
- **Abdullahi Abdi Ahmed**
- **Ancaam Awil**
- **Shukri Dahir**
## API Documentation
The API documentation is available at [Postman](Postman)
### Basic Endpoints
| Method | Endpoint | Description |
| ------ | ---------------------------- | --------------------------- |
| `POST` | /api/v1/auth/register | Register a new user |
| `POST` | /api/v1/auth/login | Login a user |
| `POST` | /api/v1/auth/logout | Logout a user |
| `POST` | /api/v1/auth/refresh | Refresh a user's token |
| `POST` | /api/v1/auth/forgot-password | Send a password reset email |
| `POST` | /api/v1/auth/reset-password | Reset a user's password |
## Contributing
Contributions are welcome. Feel free to open a pull request or an issue.