Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 3.18 KB

README.md

File metadata and controls

85 lines (52 loc) · 3.18 KB
Raw

Udyam Frontend

This repository serves as the home for Udyam Frontend.

Setting up the project

Follow the following steps to setup this project.

Note - This project requires Nodejs(v.14.0+) and npm(v.6.4+), so make sure you have installed and updated them to their respective required versions before continuing.

Fork this repository

First of all, click on the top-right corner of this repository to fork it.

Create a local clone of your fork

Then, clone your forked repository using this command:

git clone https://github.com/YOUR-USERNAME/udyam22-frontend.git

Change your current directory to the repo's root.

cd udyam22-frontend

Run the server

Install the dependencies using

npm i

Then you can finally run the server using this command.

npm start

Then you can go to localhost:3000 in your browser, where your application will be running. Also make sure you keep the terminal running at all times for changes and automatic reloads to take place.

Contributing Guidelines

  • Always pull the latest changes from the main branch before starting development.
  • When you want to merge your changes, make a pull request and ask for review from Seniors and/or authorized persons.
  • Your pull request should contain a descriptive tilte and the description should be clear and concise.
  • Dont push your changes directly even if you have write access to this repository. Resolve conflicts in case of merge conflicts. Happy hacking.

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.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.