Code Monkey home page Code Monkey logo

discussion-board's Introduction

๐Ÿง discussion-board

Contributors Forks Stargazers Issues MIT License

๐Ÿ“ 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.

discussion-board's People

Contributors

aipioxtechson avatar jcserv avatar krishchow avatar sabbas2018 avatar nivedithak avatar miosenpai avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.