frontend

frontend copied to clipboard

Setup

Install dependencies:

npm i

Running the client server locally:

npm run start

Running tests:

npm run test

Note: Even if you aren't developing the backend, you should set up the the backend and run it locally so that the frontend has a local API to talk to.

Overview of Codebuddies

What is CodeBuddies?

CodeBuddies is a remote-first community of independent code learners who enjoy sharing knowledge and helping each other learn faster via discussions and pairing. It is free and open-sourced, and supported by open source contributors and financial backers on our Open Collective.

CodeBuddies website Version 3 (CBV3)

We are building out a new platform (CBV3) to replace an older MeteorJS project which currently runs the codebuddies.org site.

Sponsors

Big thanks to the sponsors of this project!

Role of the front-end

The front-end is a React app that aims to let users at a bare minimum:

• submit resources
• meet remotely on Zoom to pair, show off a project, hack on an open source project, or study together.

Helpful links

1/ CBV3's backend API is built using Django and Django REST Framework.

2/ Some Google doc technical notes from hangouts/pairing sessions

3/ We have a technical decision log here and a group blog experiment here

4/ Crowdsourced brainstorm of problems we want to solve for our community with this platform

Technologies we're using

• React (hooks)
• Storybook
• React testing library
• Django REST Framework (for the backend API)

Application Deployment

Special thanks to Netlify for sponsoring our front-end hosting!

How do I contribute to this codebase?

Follow the CONTRIBUTING.md instructions!

Have Questions about CBV3?

Check out SUPPORT.md if you're stuck or have questions.

Ways to Get Involved

Anyone is welcome to contribute and make this project better! You can:

• Join our slack community here
• Share your feedback on Github CBV3 frontend issues
• Help review CBV3 frontend pull requests with comments!

CODE OF CONDUCT.md

Please read CodeBuddies' Code of Conduct to understand the responsibility and scope as a contributor at CodeBuddies.