.
โโโ backend
| |โโ httpd
| | โโโ main.go # Contains the api routes for communication between the front and backend
| |โโ scripts
| | โโโ setup.sh # shell script for setting up go
| |โโ storage # Contains database schema
| | |โโ discussion-board.sql
| | โโโ README.md
| |โโ wss # Contains the go files for web socket communication
| | |โโ client.go
| | |โโ hub.go
| | โโโ main.go
| โโโ README.md # Contains documentation and structure of backend api
โโโ frontend
โย ย โโโ content
โย ย โย ย โโโ locale # Contains language files
โย ย โโโ network # helpers for making http requests via axios
โย ย โโโ pages
โย ย โย ย โโโ api
โย ย โย ย โโโ home
โย ย โย ย โโโ _app.tsx # providers/wrappers for app
โย ย โย ย โโโ index.tsx # content for root page
โย ย โโโ stores
โย ย โโโ stories
โย ย โโโ styles
โโโ README.md # You are here! :)
Dialog follows Gitflow. We practice CI/CD where we continuously deploy off of main and use develop for feature work.
โโโโโโโโโโโโโโโโโโโโโโโโ main โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ # Deployments
โ โ
โโโโโโโโโโโโโโ develop โโโโโโโโโโโโโ # Development work
โ โ
โโโโโโโโโโ DEV-XXX โโโโโโโโโ # Feature branches
For internal team:
- Clone the repo
- See featurework
For open source contributors:
- Fork the repo
git remote add upstream https://github.com/white-van/discussion-board/
git fetch upstream
git rebase upstream/develop
- See featurework
Frontend Acceptance Criteria:
- It should be properly linted/formatted (run
make prettier
) - Adequate automated test coverage
- Basic manual QA & accessibility checks with Axe
Backend Acceptance Criteria: WIP
git checkout -b DEV-000
(where 000 corresponds to the issue number)- Write your code
- Open a PR from that branch to develop (in the main repo)
- Fill out the pull request template accordingly
- To be approved, code must have adequate test coverage + formatted properly
- Check frontend formatting with
npm run lint
andmake prettier
- Commits should be squashed
- Download Docker
cd frontend && npm install
make run
Distributed under the MIT License. See LICENSE
for more information.