Setting up a development environment

Prerequisites

You will need:

• SSH Keys
  • You'll need these to access git in the preferred way, through SSH
  • Follow this on how to do it
• git: latest versions work fine, I have never encountered issues with versions of git before
  • To interact with the repo
• node: 22.X
  • To install the dependencies of the project
  • You may want to use Node Version Manager nvm to manage your Node version, in case you're working on other Node projects
• npm: 10.9.X
• The Angular CLI: 20.X.X
  • This is used to generate all the components, services, directives, etc. in Angular.
  • Invoke commands with ng <command>
  • You need to install it globally (-g) so that you can use it without npm

npm install -g @angular/cli

Development

0. If you're not on the W3 committee you won't be able to submit changes to the main repo. You will need to fork it first.

1. Clone the repo (use SSH):

git clone [email protected]:CSSS/csss-site-frontend.git # if you forked the repo use your forked URL

2. Install the dependencies:

npm ci

3. Start the frontend server:

npm run start // will run some pre-build scripts
or
ng serve // only works after building

4. Access the site on your browser at localhost:8080. You're all done!

Optionals

• You can serve the website over your local network, so you can test it on a different device. Run the following command:

ng serve --host=0.0.0.0

and then you can access the site on a device on the same network at http://<IP of hosting device>:8080