The Codidact project landing page. It should contain a high-level overview of what the Codidact project is about, as well as references to resources such as the forums, Wiki, and chat.
This site is live at https://codidact.org.
A staging environment is available at https://codidact.github.io/landing-page (deployed via GitHub Pages based on the gh-pages branch).
- Ensure node and npm are installed locally (nvm recommended).
- Run
npm installto install project dependencies.
Whilst CI tools will be used at a later date, before submitting a PR ensure your code is linted by running npm run lint. Any submitted PRs will be rejected if linting does not pass.
- All formatting (except JS) is handled by Prettier (we recommend installing an auto-formatter for your IDE). The configuration is located in
.prettierrc. - JS formatting and linting is handled by ESLint. JSON config resides in
.eslintrc(to be added). - CSS linting handled by stylelint. JSON config in
.stylelintrc.