devpendent / website

👨🏻‍💻 An Open Sourced Platform for Indonesia Election Real Count
https://devpendent.netlify.com/
MIT License
27 stars 6 forks source link

Devpendent Website 👨🏻‍💻

CircleCI codecov Maintainability Netlify Status

👨🏻‍💻 An Open Sourced Platform for Indonesia Election Real Count
💻 Live site

Table of Contents

Installation

  1. Make sure yarn is installed in your local machine.
  2. Clone this project and run yarn in the project's root directory.
git clone git@github.com:devpendent/website.git
cd website
yarn

Available Scripts

In the project's root directory, you can run:

Development

yarn develop

Runs the app in the development mode.
The app will be running at http://localhost:8000!

Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

Open the website directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

yarn start

Just an alias yarn develop, for you who are used to type yarn start instead. 😁

Building

yarn build

Builds the app for production to the public folder.

yarn serve

Serves the built assets from the yarn:build command above.

Testing

yarn test

Launches the test runner in the interactive watch mode.

yarn test:coverage

Run test once and return coverage report afterwards.

yarn test:e2e

Run end-to-end tests using Cypress.

yarn validate

Validates that all tests are passed properly.

Formatting

yarn format

Manually triggers Prettier format & ESLint fix towards all js & json files. By default it has to be run automatically on save in your IDE (for Visual Studio Code users, the configurations are already included in this project).

It also will be run each time before you commit (pre-commit hook). This way, we can prevent unformatted file to be committed to the repository.

Continuous Integration

Before running commands below, you have to install & setup CircleCI CLI in your local machine by following these two steps:

  1. Install
  2. Configure

yarn ci:validate

Validate the current CircleCI config

yarn ci:process

Process the current CircleCI config

License

© Copyright 2019 Devpendent Team, The MIT License (MIT).

For more information, see the LICENSE file in this directory.