Server for my personal website. This project stores a local copy of all my current GitHub repositories in a PostgreSQL database. The database is updated by a cron-job every couple of hours.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You'll need to install the following software:
Docker
Docker Compose
NodeJs v12.13 (dev only)
Yarn v.19 (dev only)
A step by step series of examples that tell you how to get a testing env running.
Once the repo has been cloned, build the dock compose images for testing:
docker-compose -f docker-compose.yml -f docker-compose.prod.yml build
Start the project locally on port 80:
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up
Go to http://localhost:80 to see the site.
To stop the services: CTRL+c
A step by step series of examples that tell you how to get a development env running.
Once the repo has been cloned, install the dependencies:
yarn install
Build the dock compose images:
docker-compose build
Start the project locally on port 9000:
docker-compose up
Go to http://localhost:9000 to see the site.
To stop the services: CTRL+c
- Docker, docker-compose - Containers
- Node.js - Environment to run JavaScript server-side
- Express.js - Web framework for Node.js
- Express-validator - Express middleware for the validator module
- GraphQL request - GraphQL client
- HelmetJS - Express.js security with HTTP headers
- ip-cidr - Module for working with CIDR (v4, v6)
- Markdown-it - Markdown parser
- pg - PostgreSQL client - pure javascript & libpq with the same API
- squirrellyJS - JS template engine
- TinyColor2 - Color manipulation and conversion
- UUID - RFC4122 (v1, v4, and v5) UUIDs
- Bulma - Modern CSS framework based on Flexbox
- Concurrently - Run commands concurrently
- ESLint - An AST-based pattern checker for JavaScript
- eslint-config-airbnb-base - Airbnb's base JS ESLint config, following our styleguide
- eslint-plugin-import - Import with sanity
- node-sass - Wrapper around libsass
- nodemon - Simple monitor script for use during development of a node.js app
- TypeScript - Typed superset of JavaScript
I use SemVer for versioning. For the versions available, see the tags on this repository.
- Henry Brown - Initial work - HenryBrown0
This project is licensed under the MIT License - see the LICENSE.md file for details.