iamdevlinph/projects-tracker

Track multiple public github repositories in one place.

Projects Tracker

Track multiple public github repositories in one place.

React-Pkg Dependency Status

Repository Status

Includes

• React
• Redux
• redux-saga
• React Loadable
• React Router
• Webpack
• Ducks Pattern "Official Proposal"
• styled-components
• lint-staged for pre-commit hooks
• Firebase & FireStore

More here on the convenience package

App Structure

react-kit/
  .vscode/
  build/
  config/
  public/
  scripts/
  src/
  --components/
  --containers
  --routes/
  --sagaDucks/
  --services/
  --App.js
  --index.js
  --registerServiceWorker.js
  --store.js
  package.json
  README.md

Getting Started

At the time of writing this, the following versions were used

node -v 8.11.3
npm -v 6.2.0

Install the packages

npm run install

Install firebase-tools and eslint globally

npm install -g firebase-tools eslint

Commands

Run with npm run <command> if necessary

• start - Start the app and serve firebase locally. Access at http://localhost:3000/
• deploy - Deploy production build to gh-pages branch and deploy firebase functions.
• build - Will create a production ready build to the build folder.
• precommit - The precommit hook which runs lint-staged to lint staged files on commit.
• precommit:init - Install precommit related tools independently if you cannot see a precommit hook when you do a commit.

Development

To start development server and access the site at localhost:3000/

npm run start

And if you only want to build the files

npm run build-only

Deploy firebase functions

firebase login // if needed
firebase deploy

Making it yours

Update the following files:

• Firebase App Config
• Firebase Function API Url
• Homepage Field in package.json. Read more here
• README.md Variables
• Link to your Github repo in the navbar.js

Deployment

The deployment process in this app only supports github pages using the gh-pages branch. To set it up:

1. Make necessary changes to your repository's settings.

Change the source to gh-pages branch.

If you have your own domain. Input your custom domain if you have and don't forget to add a CNAME file in the public folder. This will handle the redirecting from github pages to your custom domain.

2. In the package.json change the homepage property with the url where the app will be accessed

// for github pages domain
"homepage": "https://<username>.github.io/<repository_name>"

// for custom domains just put your own domain
"homepage": "<your_custom_domain_here>"

3. After setting up the correct url for homepage you can now deploy using

npm run deploy

This will build the files and deploy them to the gh-pages branch

4. Access your app with the url you used in the homepage property.

---

This project was bootstrapped with React Kit which is based on Create React App.

Read the original README.md