https://github.com/pranay-0512/codesk-service-old
The backend repository for the collaborative whiteboard application, coCanvas, manages user authentication, real-time collaboration through Websockets, and database interactions. It is built using FastAPI and PostgreSQL, providing a scalable and secure foundation for the collaborative features of the application.
https://github.com/pranay-0512/codesk-service-old
Last synced: 3 months ago
JSON representation
The backend repository for the collaborative whiteboard application, coCanvas, manages user authentication, real-time collaboration through Websockets, and database interactions. It is built using FastAPI and PostgreSQL, providing a scalable and secure foundation for the collaborative features of the application.
- Host: GitHub
- URL: https://github.com/pranay-0512/codesk-service-old
- Owner: pranay-0512
- Created: 2024-02-20T13:05:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-21T05:56:14.000Z (about 1 year ago)
- Last Synced: 2024-12-27T18:16:56.850Z (5 months ago)
- Language: Python
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# coCanvas - service
Short description of the project.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)s
- [Database Setup](#database-setup)
- [Contributing](#contributing)
- [License](#license)
## Installation
1. Clone the repository.
2. Install the required dependencies using `pip install -r requirements.txt`.
3. Set up the database (see [Database Setup](#database-setup)).
4. Run the server using `uvicorn main:app --reload`.
## Usage
Describe how to use the server and any additional configuration or setup required.
## API Documentation
Provide a link or instructions on how to access the API documentation.
## Database Setup
1. Install PostgreSQL.
2. Create a new database.
3. Update the database connection details in the configuration file.
4. Run the database migrations using `alembic upgrade head`.
## Contributing
Explain how others can contribute to the project and any guidelines they should follow.
## License
Specify the license under which the project is distributed.