https://github.com/shiyinq/noto

📒 A note-taking application.
https://github.com/shiyinq/noto

note notebook noto

Last synced: about 12 hours ago
JSON representation

📒 A note-taking application.

• Host: GitHub
• URL: https://github.com/shiyinq/noto
• Owner: Shiyinq
• License: gpl-3.0
• Created: 2024-07-14T14:21:15.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T11:43:11.000Z (3 months ago)
• Last Synced: 2024-08-29T12:42:23.503Z (3 months ago)
• Topics: note, notebook, noto
• Language: Go
• Homepage:
• Size: 164 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NOTO ![Status](https://img.shields.io/badge/status-in%20development-yellow)

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 ](#noto-)

- [Table of Contents](#table-of-contents)

  - [Development](#development)

    - [Running Local Server](#running-local-server)

    - [Generate Swagger Documentation](#generate-swagger-documentation)

  - [Deployment](#deployment)

## Development

### Running Local Server

1. **Clone the Repository**

   ```sh

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

   cd noto

   ```

2. **Install Go Modules**

   ```sh

   go mod tidy

   ```

3. **Create .env File**

   ```sh

   cp .env.example .env

   ```

4. **Install Air for Live Reloading**

   If you don't have `air` installed on your machine, install it first:

   ```sh

   go install github.com/air-verse/air@latest

   ```

5. **Run the Development Server**

   ```sh

   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:

   ```sh

   go install github.com/swaggo/swag/cmd/swag@latest

   ```

2. **Generate or Update Documentation**

    ```sh

    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](https://docs.docker.com/engine/install/) installed.

**1. Clone the Repository**

```sh

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

cd noto

```

**2. Create Environment Files**

For the backend:

```sh

cp .env.example .env

```

For the frontend:

```sh

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**

```sh

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