Skip to content

Latest commit

 

History

History
executable file
·
81 lines (52 loc) · 2.02 KB

README.md

File metadata and controls

executable file
·
81 lines (52 loc) · 2.02 KB

Wafrn - Angular

This package is the frontend of Wafrn.

The frontend of Wafrn uses Angular. Have fun doing stuff ;D

Installation

Prerequisites

This project uses NPM. You can check that NPM is installed in the terminal by running:

npm -v

Setup

First, fork the repo.

Once the prerequisites are installed, and you are working off the fork, clone the repository to your local machine.

This can be done from the command line:

git clone [email protected]:[YOUR USERNAME HERE]/wafrn.git ./wafrn

Local Development

You can run the development server through the command line:

npm run frontend:develop      # Point to local backend
npm run frontend:develop:prod # Point to production backend

If you have Nix installed, you can also run the development environment through the provided shell.nix file which includes Node 20.

nix-shell

# Now in nix shell with Node 20 installed

To run the frontend pointing to the production server and immediately exit upon the command's completion, you can run:

nix-shell --command "trap 'exit' INT;npm run frontend:develop:prod"

In either case, when the server is set up, you should get a success message:

Watch mode enabled. Watching for file changes...
  ➜  Local:   http://localhost:4200/
  ➜  press h + enter to show help

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Merge pull requests to the main branch.

License

Apache License 2.0