NOTO

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.

Table of Contents

• NOTO
• Table of Contents
  • Development
    • Running Local Server
    • Generate Swagger Documentation
  • Deployment

Development

Running Local Server

1. Clone the Repository

   git clone https://github.com/Shiyinq/noto.git
   cd noto

2. Install Go Modules

   go mod tidy

3. Create .env File

   cp .env.example .env

4. 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

5. Run the Development Server

   air

6. Server

   http://localhost:8080

Generate Swagger Documentation

1. 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

2. 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 swag.sh
   

   Then, run:

   ./swag.sh
   

3. Swagger Documentation

   http://localhost:8080/docs/index.html

Deployment

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