GitHub Help Wanted was built to help connect developers with open-source projects.
Checkout the site at github-help-wanted.com
Find a project where the community needs your help and dive in!
I want your help too!
I encourage you to:
- ⭐ this project
- create an issue
- post a pull request
This website is written with React and Redux using the Semantic-UI-React css framework.
note: sudo may be required for docker interaction based on your installation config.
To run the website in a local environment:
- make sure Docker is installed
- clone this repository
git clone git@github.com:mac-s-g/github-help-wanted.git
- build the docker container
cd github-help-wanted/./docker/build-container.sh
- run the development server
./docker/dev-server.sh
- navigate to http://localhost:3100/ in your web browser
After completing the steps above, you'll have webpack-dev-server running in a Docker container with hot-reloading enabled. Try updating some source code. Changes will be reflected in your browser after saving.
notes: if you change the dependencies in package.json, make sure you rebulid the container with ./docker/build-container.sh.
The build runs in a container and outputs files into github-help-wanted/dist/. Here's how to instantiate the build process:
cd github-help-wanted/./docker/build.sh- Verify the result by exploring the output in your web browser:
cd dist/- open
index.htmlin a web browser
- If your changes look good, send me a pull request!
I'd recommend using docker for development because it enforces environmental consistency.
If you'd like to contribute without docker, you can use the following workflow to run the dev-server:
# clone this repository
git clone git@github.com:mac-s-g/github-help-wanted.git
# install dependencies
npm install
# run the dev server at http://localhost:3100/
npm run dev:hot
and run the build with:
# run the build
npm run build
# copy relevant files into dist dir
cp ./src/images/favicon.ico README.md CNAME ./dist/