website public

website-public

The main C4Coin Public facing website, providing sales, marketing, and public relations information.

• develop — [insert codecov badge]
• master — [insert codecov badge]

Functional Requirements

1. Provide a curriculum (funnel) for understanding the C4Coin project
2. Provide an interactive/live development roadmap

• Represents progress of section 4.5.3 of the whitepaper
• Five Milestones

3. Display C4Coin related press and press releases
4. Drive email list sign ups (to be clarified with PR team)

• via CRM or custom built system?

5. Drive social media followers (to be clarified with PR team)
6. Content Management System (CMS) integration

Q: Will the CMS control only the blog, or being able to reorganise the entire site?

7. The C4Coin team
8. Contact information
9. Legal information

Comments: This site is relatively simple because there are no public user accounts, only internal.

Development

• The site will be built to conform to the general coding standards common to all of the C4Coin sites.
• The 'fractal' React app structure will generally be followed. The redux store, however, will not follow the fractal pattern and will be kept flat

Development Prerequisites

• NodeJS, version 9.7.1 or better (I use nvm to manage Node versions — brew install nvm.)
• Docker (Use Docker for Mac, not the homebrew version)
• Access to the C4Coin Jira
• Environment Variables
• requirements google doc

Getting Started

After cloning this repository, there are only two steps needed to run the the website locally.

1. Install dependencies with npm install
2. Setup the environment variables for the project by creating a .env file in the root folder, and setting it's contents to the c4coin .env confluence file

Installation

npm install

Testing

npm test

or with code coverage

npm run test:cov

Linting

npm run lint

Deployment

The site will be deployed automatically to netlify once CircleCI has cleared a merge to either develop (staging server) or master (production).

Contributing

Please see the contributing notes.