README.md

🧐 discussion-board

📁 Project Structure

.
├── 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! :)

💡 Contributing

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:

1. Clone the repo
2. See featurework

For open source contributors:

1. Fork the repo
2. git remote add upstream https://github.com/white-van/discussion-board/
3. git fetch upstream
4. git rebase upstream/develop
5. See featurework

Frontend Acceptance Criteria:

1. It should be properly linted/formatted (run make prettier)
2. Adequate automated test coverage
3. Basic manual QA & accessibility checks with Axe

Backend Acceptance Criteria: WIP

⛏️ Featurework:

1. git checkout -b DEV-000 (where 000 corresponds to the issue number)
2. Write your code
3. Open a PR from that branch to develop (in the main repo)
4. Fill out the pull request template accordingly
5. To be approved, code must have adequate test coverage + formatted properly
6. Check frontend formatting with npm run lint and make prettier
7. Commits should be squashed

🚀 Local Development

1. Download Docker
2. cd frontend && npm install
3. make run

🏁 License

Distributed under the MIT License. See LICENSE for more information.