Fractal Website

THIS REPOSITORY WAS ARCHIVED FOLLOWING OUR MIGRATION FROM VIRTUAL MACHINES TO CONTAINERS, FOR WHICH WE CREATED A NEW WEBSITE. ALL NETLIFY HOSTS AND OTHER HOSTING SERVICES WERE DELETED. AS SUCH, THE INSTRUCTIONS BELOW MAY NO LONGER APPLY. THE REPOSITORY IS LEFT AS ARCHIVED HERE FOR REFERENCE.

This repository contains the code for the Fractal website where users create and manage their account. It interfaces with the webservers and the admin dashboard.

The Netlify staging version of the website is hosted here.

Development

The admin dashboard is developed using the npm package manager. You can start developing by running npm install, and can launch into a localhost via npm start.

If you need to update dependencies, you can run npm upgrade, followed by npm prune to remove unnecessary dependencies.

Note that the main branch autodeploys to fractalcomputers.com and should only be pushed to when code has been properly tested. The staging branch autodeploys to fractalcomputers.netlify.com and is the recommended branch to branch from when working on a feature, and the branch to PR into.

Basic continuous integration is set up for this project. For every push or PR, basic NodeJS tests will be compiled and run within GitHub Actions. This will also auto-format the code via Prettier, see below. You should make sure that every push to master passes the build in GitHub Actions.

Styling

To ensure that code formatting is standardized, and to minimize clutter in the commits, you should set up styling with Prettier before making any PRs. We have pre-commit hooks with Prettier support installed on this project, which you can initialize by first installing pre-commit via pip install pre-commit and then running pre-commit install to instantiate the hooks for Prettier.

You can always run Prettier directly from a terminal by typing npm run format, or you can install it directly within your IDE by via the following instructions:

VSCode

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.

ext install esbenp.prettier-vscode

To ensure that this extension is used over other extensions you may have installed, be sure to set it as the default formatter in your VS Code settings. This setting can be set for all languages or by a specific language.

{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}