schalkventer / tech-for-good

🌍 Resources for South Africans interested in the intersection between technology and social good

Public People Frontend ·

🌍 This repo contains the Tech for Good static site.

Stack

Built with Gatsby

The following Gatsby plugins are used:

• gatsby-link
• gatsby-plugin-google-fonts
• gatsby-plugin-react-helmet
• gatsby-plugin-sass
• gatsby-source-filesystem
• gatsby-transformer-remark

Conventions

Files

• Underlying file architecture corresponds to guidelines established in Gatsby documentation.

CSS

• Tailwind CSS is included for CSS utility classes.

Development

1. Clone this project by running git clone https://github.com/schalkventer/tech-for-good.git.
2. Make sure you have NodeJS installed.
3. Run npm install in the root folder of the repository.
4. Run npm start to spin up the development server.*
5. Open localhost:8000 in your browser.

* Development server uses hot-reloading. Changes will reflect immediately on localhost:8000 without refreshing the browser.

Deployment

1. Code is merged into master on Github.
2. Netlify builds a new static site instance of the repo via npm run build.
3. If build is valid it will be deployed to Netlify at techforgood.org.za.