landing-page

codidact/landing-page

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 Wiki, Meta, 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).

Setting up your local development environment

• Ensure node and npm are installed locally (nvm recommended).
• Set node version to 16.14.0. You can install it using nvm install 16.14.0, and running nvm use 16.14.0 to use it in the project.
• Run npm install to install project dependencies.
• Run npm run start to start the front-end. This can be viewed by navigating to localhost:3000 in your browser.

Docker

Alternatively, our Docker setup can be used. Having either Docker Desktop or Docker Engine is a prerequisite. If used with Docker Compose (see compose.yml for configuration), docker-compose-plugin also has to be installed. To set up the project with Compose:

1. Run docker compose up from project root (see the official reference for details & other commands);
2. Connect to the container by running docker exec -it landing-page-dev bash (assuming you want to use bash as your shell);
3. If it’s a clean build or if dependencies have changed, run npm ci from the container;

Build outputs are part of the repo

After you make changes, build:

npm run build

This should make changes in dist. Include those in your commit.

Linting

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.

Copying

MIT license applies to source code. It does not apply to assets under dist/assets/img/, particulary not to those within dist/assets/img/3rd-party/. Same applies to src/img/.

This site is open source. Improve this page.