This project is officially deprecated. All functionality has been moved to the Website Honestly project.
We have a .nvmrc
file so you can get a compatible version of Node using NVM:
nvm install
nvm use
Install your dependencies with npm install
.
Website-next is using Badger Brain GraphQL server as a source of data. In order to get things running locally you will have to clone, build and run Badger Brain on your machine.
Clone Badger Brain, then npm i && npm run build && npm start
.
Badger Brain will try to fetch data from our endpoints. At the moment the only supported endpoint is Prismic.io.
To build the project run npm run build
.
Run the server with npm start
and navigate to http://localhost:8000/about-us/join-us
.
Run the following:
npm run local
The site can then be accessed at http://localhost:8000.
Any changes you make will be linted and tested on a git push
. To run linting yourself you can do npm run lint
.
We use dotenv
to configure our environment variables in development. Create a .env
file in the root folder of the project to make use of this feature. Required keys are outlined below:
WORKABLE_KEY=your_key_here
Workable API key is only accessible on Workable site to Becca Evans - but you can also ping @asavin for the key.
The project has code that is run on a server, a client and both. We can test for each intended environment with the following commands:
You can run the server tests with:
npm run test:server
npm run test:client
.
We also have end to end tests that only test the 'Golden Paths' for the
website. These can be run with npm run test:e2e
. Note that they require a running server.
Pushing and merging into master
branch will automatically trigger CircleCI builds and will deploy the app to http://www-staging.red-badger.com/about-us/join-us.
In order to promote staging build to production you have to create and publish new release tag in the format of v0.1.2
. This will initialise new CircleCI build and it will deploy app to production on success.