mirror of
https://github.com/wassname/Open-Assistant.git
synced 2026-06-27 16:10:30 +08:00
updated readme
This commit is contained in:
@@ -10,10 +10,38 @@ All open source projects begins with people like you. Open source is the belief
|
||||
|
||||
## I’m in! Now what?
|
||||
|
||||
We live and collaborate the work in the LAION discord. Join us!
|
||||
[Fill out the contributor signup form](https://docs.google.com/forms/d/e/1FAIpQLSeuggO7UdYkBvGLEJldDvxp6DwaRbW5p7dl96UzFkZgziRTrQ/viewform)
|
||||
|
||||
[Join the LAION Discord Server!](https://discord.gg/RQFtmAmk)
|
||||
|
||||
[Visit the Notion](https://ykilcher.com/open-chat-gpt)
|
||||
|
||||
## Developer Setup
|
||||
|
||||
Work is organized in the [project board](https://github.com/orgs/LAION-AI/projects/3).
|
||||
|
||||
### Python Backend
|
||||
|
||||
For a local developer setup, look into the `backend` folder to pull up a local database and backend.
|
||||
|
||||
There is also a minimal implementation of a frontend in the `text-frontend` folder.
|
||||
|
||||
We are using Python 3.10
|
||||
|
||||
Check out the [High-Level Protocol Architecture](https://www.notion.so/High-Level-Protocol-Architecture-6f1fd3551da74213b560ead369f132dc)
|
||||
|
||||
### Website
|
||||
|
||||
The website is built using Next.js and is in the `website` folder.
|
||||
|
||||
### Pre-commit
|
||||
|
||||
Install `pre-commit` and run `pre-commit install` to install the pre-commit hooks.
|
||||
|
||||
In case you haven't done this, have already committed, and CI is failing, you can run `pre-commit run --all-files` to run the pre-commit hooks on all files.
|
||||
|
||||
# (Older version of the readme below)
|
||||
|
||||
## How do I start helping out?
|
||||
|
||||
Check out these pages to learn more about the project.
|
||||
@@ -28,10 +56,6 @@ https://roan-iguanadon-a58.notion.site/Open-Chat-Gpt-83dd217eeeb84907a155b8a9d71
|
||||
|
||||
## Code structure
|
||||
|
||||
### Pre-commit
|
||||
|
||||
Run `pre-commit install` to install the pre-commit hooks.
|
||||
|
||||
### Bot
|
||||
|
||||
We have a folder named bot where code related to the bot lives.
|
||||
|
||||
Reference in New Issue
Block a user