Skip to content

Ruth-ikegah/badging-website

 
 

Repository files navigation

Frame68

DEI Badging

The DEI Badging initiative is an award system whereby open-source events earn badges and enhance their events to be more inclusive using the feedback they get from reviewers. The DEI badges help nurture a system that promotes leadership, self-reflection, and self-improvement on issues critical to building the Internet as a social good.

Aim of the DEI Badging

  • Establish an environment where events can engage in the badging program
  • Aligning the badging program with best practices, guidelines, and recommendations from Diversity & Inclusion efforts on the CHAOSS project
  • Connect with existing badging standards of IMS Global including
  • Building an open, peer-review system for the D&I Badging Program To learn more about DEI Badging, please check out the CHAOSS Community Handbook.

Badging Website

This website was created to help event organizers easily register their events to get badged. This evnt badge focuses on the experience of the event attendees(everyone present at the event), improving DEI in open-source events.

Contributing To this Project

To contribute to this project please follow the guidelines found in our CONTRIBUTION.md! file. This project is open for contribution to all from newbie to expert regardless if you're working on your 1000th contribution to open source or your 1st.

Project Setup Guidelines


The repository has two main branches,

  • main: For production. this is currently running on this instance
  • staging: The development branch that is used for all test purposes and currently running on this instance.

To get your local instance up and running; Ensure that you have node and npm installed on your local machine. if not, check out this digitalocean robust tutorial depending on what operating system you are using.

  1. Fork and Clone this repository
  git clone https://github.com/BADGING/badging-website.git

Make sure to replace BADGING with your GitHub username 2. Move into the project folder

cd badging-website
  1. Run the code below to install additional dependencies
npm install
  1. Once all packages have been installed run
npm run dev

Your app should be running on http://localhost:5050

Build the Project

Incase you want to build the project before pushing it.

  1. Create an .env file in the website folder and and supply a port number
# supply a port number
PORT=3000
  1. Build the project
npm run build
  1. Start the local server
npm start

Your built app will run on the port you supplied in the env file and for this case, http://localhost:3000

Website Maintainers

About

Home of the CHAOSS DEI Badging, a CHAOSS Project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 88.9%
  • HTML 5.1%
  • SCSS 4.1%
  • Shell 1.9%