Skip to content

Aye-saac/website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ayesaac: Website

Build Status

Development

Installing things

Prerequisites

  1. Install the LTS version of Node.js.
  2. Install Yarn.

Dependencies

  1. Clone the repository
  2. Navigate to the folder
  3. Run yarn to install the dependencies
  4. Run yarn start to start the development server.

Available Scripts

In the project directory, you can run:

  • yarn start - Runs the app in the development mode at http://localhost:3000.
  • yarn test - Launches the test runner in the interactive watch mode.
  • yarn build - Builds production version to build folder, optimising for best performance. See the section about deployment for more information.
  • yarn lint - Lints project files.
  • yarn fix - Same as yarn lint, but also fixes errors where possible.
  • yarn generate - Scaffold files for quicker development.

There are more scripts that are not listed above. The full list of scripts are within the package.json file.

Technology stack

Dependencies

Developer dependencies

Yarn (v2)

Yarn was used during development, which is why there is a yarn.lock file instead of a package-lock.json file. Ultimately use whatever you're comfortable with, but know the differences.

I've used Yarn v2 for this project, but I have not used PnP — I kept coming across issues during setup so I am using Yarn v2 with the node-modules plugin.

Aliased imports

I get annoyed at seeing loads of relative importing paths, so absolute import aliasing has been used. This is why there are capital letters used for the immediate directory under src/.

Redux configuration

The template provides basic Redux configuration with feature based folder structure. You can use Redux devtools browser extension. Based on Redux maintainers recommendation.