A directory for freeCodeCamp's Open Source for Good apps - solutions for nonprofits
A directory for freeCodeCamp's Open Source for Good Apps - Solutions for Nonprofits.
There are two steps to add an Open Source for Good Project to the directory:
Add the file .osfg-dir-config.js
to the root of the Project.
This will trigger an automatic build of the Project's page inside the directory.
Please verify that an update by CamperBot to docs/[project-name]
has occurred in the master branch of the directory.
Fields:
liveDemo
or the demoVideo
aren't yet available, you can exclued them. They just won't be added to the project's page.You can see a sample config file at the root of this repository.
Edit the file repo-list.json
at the root of the directory to include the project.
'dev'
and 'prod'
. Projects in 'dev'
won't be displayed to nonprofits (unauthenticated users).Please be paitient and while GitHub updates the directory - it will take a few minutes before the changes are reflected.
Make sure you have installed a recent version of NodeJS and npm.
Open the folder you wish to install the project in using your terminal, and run:
git clone https://github.com/freeCodeCamp/open-source-for-good-directory
cd
into the open-source-for-good-directory
project that command created, then run npm i
to install all the project dependencies.
You'll need symbolic links inside the public
folder that point to the corresponding docs/[project-name]
directory. The bash script in the root of this repo. We've created a script to automate this process. Make sure the script is executable by running: chmod +x .setup-symlinks.sh
. Then run ./.setup-symlinks.sh
.
For Windows users wanting to use the script, you'll probably need the Linux Subsystem. We haven't tested this, so if you get this working, let us know how you did so, and we can add those steps to this guide.
This directory is built using Create React App, so you can look for more info there if you run into trouble.
To deploy the directory, run yarn build
or npm run build
. Then commit the changes to Github.
The directory depends on a remote server to perform an automated webpage build for each project that requires it. The server works in the following way:
.osfg-dir-config.js
, it downloads the file and builds an HTML file.docs
folder.docs
folder is automatically deployed to GitHub Pages, which in turn are linked to the directory's website.You can find the code for the server in this repository
This computer software is licensed under the open source BSD-3-Clause.
Copyright (c) 2017, freeCodeCamp.