Skip to content
This repository has been archived by the owner on Sep 15, 2023. It is now read-only.

VikeLabs/Passr

Repository files navigation

Passr

Getting Started (Development)

Required Software

To develop this project you must have the following installed:

  • Git

    • Type git into your terminal/cmd to see if it is already installed
  • nodejs 12.19

    • You may have this installed if you have worked on other javascript projects. Type node -v into your terminal to see if it is installed and which version.
    • If it isn't installed, you can follow that link or use a tool called nvm for installing and managing multiple versions. Great when you work on multiple projects. If you are on Windows, checkout nvm-windows.

Steps

Once the required software is installed, do the following to run the project.

  1. Clone the project into a directory that you can easily access, like a git directory in your documents. git clone https://github.com/VikeLabs/Passr.git

  2. Run npm install to install all the npm packages

  3. Run npm start to begin running the project. See npm start for details.

  4. Now you can make edits to the JS files and see the changes refresh in the browser before your eyes.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.s

npm run lint or npm run lint:fix

Runs ESLint on all (ts,tsx,js,jsx) files in the app, the latter command also fixes any ESLint errors automatically.

npm run prettier

Runs Prettier to automatically format code on all (ts, tsx, jsx, jsx) files in the app.

Learn More

This project was bootstrapped with Create React App.

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Releases

No releases published

Packages

No packages published

Languages