Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/short-response #20

Merged
merged 3 commits into from
Jun 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Revamped [Last Projects URL Shortener API's](https://github.com/PickHD/singkatin-api) using Golang.

## Architect Overview :
![ERD](https://raw.github.com/PickHD/singkatin-revamp/master/arch_singkatin_revamp.png)
![ARCH](https://raw.github.com/PickHD/singkatin-revamp/master/arch_singkatin_revamp.png)

## Whats Changed? :
1. From Monolith to Microservices
Expand All @@ -14,9 +14,10 @@ Revamped [Last Projects URL Shortener API's](https://github.com/PickHD/singkatin
## Main Features :
1. Register
2. Login
3. User Profiles
4. User Dashboard (can analyze how much visitor / users click the short links)
5. Shortener Link Redirect
3. Reset Password
4. User Profiles
5. User Dashboard (can analyze how much visitor / users click the short links)
6. Shortener Link Redirect

## Tech Used :
1. Golang _(Every services using different framework due experimenting performances.)_
Expand All @@ -31,30 +32,23 @@ Revamped [Last Projects URL Shortener API's](https://github.com/PickHD/singkatin
## Prerequisites :
1. Make sure Docker & Docker Compose already installed on your machine
2. Rename `example.env` to `.env` on folder `./cmd/v1` every services
3. Make sure to uncheck comment & fill your **SMTP configuration** on auth env

## Setup :
1. To build all services, run command :
```
$ make build
make build
```

2. You can build & run all services in background using command :
```
$ make run
make run
```
3. If you want to stop all services then run :
```
$ make stop
make stop
```
4. Last if want to stop & remove entire services then run :
```
$ make remove
```


## Next Features (In Development) :
- Email Verification Register ✔️
- Forgot Password ✔️
- Edit Profile ✔️
- Upload Avatar Users ✔️
- User Shorteners Advance Management ✔️
make remove
```
Loading