README updates
This commit is contained in:
parent
5ae12a2983
commit
e2fe993859
24
README.md
24
README.md
@ -2,6 +2,7 @@
|
||||
|
||||
A messageboard type social website
|
||||
|
||||
The expected target environment is linux.
|
||||
## Backend
|
||||
Fully coded in golang utilizing the following technologies:
|
||||
- https://github.com/gofiber/fiber
|
||||
@ -12,11 +13,18 @@ The backend consists of multiple modules:
|
||||
- auth.go: authorization module with jwt tokens setup
|
||||
- server.go: main buisness logic functionality
|
||||
|
||||
|
||||
running the backend without docker requires:
|
||||
```sh
|
||||
go mody tidy
|
||||
go build
|
||||
./social-network
|
||||
```
|
||||
|
||||
## Frontend
|
||||
Typescript + nextjs + tailwindcss
|
||||
|
||||
all of the required packages are in `package.json` file
|
||||
|
||||
the frontend uses nextjs for server side rendering.
|
||||
|
||||
there are multiple pages each responsible for its own functionality:
|
||||
@ -26,7 +34,11 @@ there are multiple pages each responsible for its own functionality:
|
||||
- profile.tsx: mounted on `/profile` is for the user profile info.
|
||||
- signup.tsx: mounted on `/signup` is for registering new users.
|
||||
|
||||
|
||||
running the frontend manually can be done through
|
||||
```sh
|
||||
npm i
|
||||
npm run dev
|
||||
```
|
||||
|
||||
|
||||
## Devops
|
||||
@ -43,6 +55,14 @@ frontend setup has 3 containers:
|
||||
|
||||
all of the previous services are running on `internalnet` virtual network and then afterwards its served with a nginx reverse proxy for traffic management and redundancy purposes
|
||||
|
||||
afterwards the application should be up and running http://localhost
|
||||
|
||||
the app can be turned off and on and removed through the following scripts:
|
||||
```
|
||||
start-app.sh
|
||||
stop-app.sh
|
||||
remove-app.sh
|
||||
```
|
||||
## TODO
|
||||
- better db management
|
||||
- more documentation
|
||||
|
Loading…
Reference in New Issue
Block a user