https://github.com/heldrida/punkbit-website-2017
the punkbit website 2017
https://github.com/heldrida/punkbit-website-2017
Last synced: 3 months ago
JSON representation
the punkbit website 2017
- Host: GitHub
- URL: https://github.com/heldrida/punkbit-website-2017
- Owner: heldrida
- Created: 2017-03-15T16:27:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-16T16:33:34.000Z (about 8 years ago)
- Last Synced: 2025-02-18T06:09:07.426Z (3 months ago)
- Language: JavaScript
- Size: 1020 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
The Punkbit Website!
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Clone the repository to your local environment, install any dependencies and install the packages. Run the development command to start a local server, run the test command to run unit tests and the build command to create a new version for release.
Use the `config.js` in the root to set any parameters, such as the `repository remote list`, it's recommended to use a PaaS like Heroku or alike to easy deployment.
### Pre-requisities
```
Nodejs & NPM
```
### Installing
```
npm install
```
## Quick look
### Build for distribution
You must run the build commands to generate a bundle js, css, images, fonts, etc, to distribute it into your test, staging or production environments. To so, you can run the commands below, that will generate the files under the `/dist` directory.
```
gulp build --env staging
```
Or,
```
gulp build --env production
```
### Development
```
gulp
```
### Test runner
```
gulp test
```
### Tests
The tests are split in two different categories, Unit and End-to-end (integration) tests. These are run separately, there are two different tasks for that matter: `gulp unit_test` & `gulp end2end_test`.
### Preview the app for distribution
Run the command below to create a small web server to serve the app that exists for distribution ( remember to run the build command to create the `dist` directory for the desired `environment`).
```
gulp preview --env staging
```
Or
```
gulp preview --env production
```
### Build architecture
Find the source code under the `src` directory for javascript and `sass` for the stylesheets. Before modifying ensure that the development watcher is running by running the development watch command (see development notes). The `dist` directory holds the files ready for distribution.
## Built With
* ReactJS
* Webpack 2
* SASS
* ES2015
* GULP
* MOCHA
* CHAI
* ENZYME
* GSAP
* STANDARDJS
* UNIVERSAL / ISOMORPHIC
### Logo