https://github.com/codidact/landing-page
Official landing page for the Codidact project
https://github.com/codidact/landing-page
Last synced: 2 months ago
JSON representation
Official landing page for the Codidact project
- Host: GitHub
- URL: https://github.com/codidact/landing-page
- Owner: codidact
- License: mit
- Created: 2019-11-03T19:08:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-07-28T17:32:33.000Z (8 months ago)
- Last Synced: 2025-07-28T19:27:50.959Z (8 months ago)
- Language: SCSS
- Homepage: https://codidact.org/
- Size: 1.59 MB
- Stars: 37
- Watchers: 10
- Forks: 15
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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](https://github.com/codidact/docs/wiki), [Meta](https://meta.codidact.com/), and [chat](https://discord.gg/PSr9pmn).
This site is live at https://codidact.org.
A staging environment is available at https://codidact.github.io/landing-page *(deployed via [GitHub Pages](https://github.com/codidact/landing-page/deployments) based on the `gh-pages` branch)*.
## Setting up your local development environment
- Ensure node and npm are installed locally [(nvm recommended)](https://github.com/nvm-sh/nvm).
- 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](https://docs.docker.com/get-started/introduction/get-docker-desktop) or [Docker Engine](https://docs.docker.com/engine/install/) is a prerequisite. If used with Docker Compose (see [compose.yml](./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](https://docs.docker.com/reference/cli/docker/compose/) 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/`.