hackathon-pack v0.1.4
Hack Pack
Getting Started
To get started, we'll need to install node. We'll also need Firebase CLI installed:
npm install -g firebase-tools
Clone and install the repo. Navigate to the directory where you want the project to live, and run:
git clone https://github.com/mathieujonson/hack-pack.git && cd hack-pack && npm install
Alternatively, you can install with npm:
npm install hackathon-pack
Common commands
To get a local up and running:
npm run start
oryarn start
To deploy to production we'll need to build first, then deploy:
npm run build
oryarn build
firebase deploy
Organization
Each component folder should contain its own tests and styles. Related components should be nested within the initial component. If a component can be shared, it should be saved in the Shared
folder. It should look something like this:
|-- src
|-- components
|-- ExampleComponent
|-- ExampleComponent.js
|-- ExampleComponent.test.js
|-- ExampleComponent.css
|-- Shared
|-- SharedExample
|-- SharedExample.js
|-- SharedExample.test.js
|-- SharedExample.css