Ocean

Getting Started with Development

Welcome to the Ocean project! To get started with developing on this project, you'll need to set up a Python virtual environment and install the required dependencies. Follow these steps:

git clone https://github.com/WRXinYue/ocean.git
cd ocean

Setting Up the Virtual Environment

python -m venv venv

Activating the Virtual Environment

On Windows:

.\venv\Scripts\activate

On MacOS/Linux:

source venv/bin/activate

Installing Dependencies

Install all the required dependencies by running:

pip install -r requirements.txt

Now, you are ready to start developing!

Notice:

1. If you are in China and your console shows an error like "losing rust-xxx" and it tells you to update your "pip" package, you can shut down the VPN.
2. Make sure your computer has the GCC environment.

Project structure

app
├── api              - web related stuff.
│   ├── dependencies - dependencies for routes definition.
│   ├── errors       - definition of error handlers.
│   └── routes       - web routes.
├── core             - application configuration, startup events, logging.
├── db               - db related stuff.
│   ├── migrations   - manually written alembic migrations.
│   └── repositories - all crud stuff.
├── models           - pydantic models for this application.
│   ├── domain       - main models that are used almost everywhere.
│   └── schemas      - schemas for using in web routes.
├── resources        - strings that are used in web responses.
├── services         - logic that is not just crud related.
├── tts              - Text to speech
└── main.py          - FastAPI application creation and configuration.

API Documentation

• OpenAPI Specification: http://127.0.0.1:8080/openapi.json
• Swagger UI: http://127.0.0.1:8080/docs
• ReDoc: http://127.0.0.1:8080/redoc