Noto γγΌγ (nΕto) is an app for storing your notes privately. You can host it on your localhost or your own server, ensuring that your data is entirely yours and not owned by anyone else.
-
Clone the Repository
git clone https://github.com/Shiyinq/noto.git cd noto
-
Install Go Modules
go mod tidy
-
Create .env File
cp .env.example .env
-
Install Air for Live Reloading
If you don't have
air
installed on your machine, install it first:go install github.com/air-verse/air@latest
-
Run the Development Server
air
-
Server
-
Install Swagger for API Documentation
If you don't have
swag
installed on your machine, install it first:go install github.com/swaggo/swag/cmd/swag@latest
-
Generate or Update Documentation
swag init -g ./cmd/server/main.go --parseDependency --parseInternal --output docs/swagger
Or you can use the
swag.sh
script:For the first time, before running the script, execute:
chmod +x docs.sh
Then, run:
./swag.sh
-
Swagger Documentation
Before you begin, ensure you have Docker installed.
1. Clone the Repository
git clone https://github.com/Shiyinq/noto.git
cd noto
2. Create Environment Files
For the backend:
cp .env.example .env
For the frontend:
cd cmd/client
cp .env.example .env
cd ../../
Open each .env
file you have created and update the values as needed.
3. Build and Run the Docker Containers
docker compose up --build -d
Wait a few minutes for the setup to complete. You can then access:
- Frontend at http://localhost:5000
- Backend at http://localhost:8080