README.md

Annadata Website

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Your machine should have Npm (or Yarn) installed to use it locally.

Setup and Installation

Setting up the repository locally

1. First fork the repo 🍴 to your account.
   Go to the forked repo and clone it 👥 to your local machine:

git clone https://github.com/Your_Username/ReactWebsite.git

This will make a copy of the code to your local machine.

2. Now move to the ReactWebsite directory.

cd ReactWebsite

3. Now check the remote of your local code by:

git remote -v

The response should look like:

origin	https://github.com/Your_Username/ReactWebsite.git (fetch)
origin	https://github.com/Your_Username/ReactWebsite.git (push)

To add upstream to remote, run:

git remote add upstream https://github.com/AnnadataHackfest/ReactWebsite.git

Again run git remote -v, the response should look like:

origin	https://github.com/Your_Username/ReactWebsite.git (fetch)
origin	https://github.com/Your_Username/ReactWebsite.git (push)
upstream	https://github.com/AnnadataHackfest/ReactWebsite (fetch)
upstream	https://github.com/AnnadataHackfest/ReactWebsite (push)

4. Once the remote is set, install all the necessary dependencies by the following command:

npm install

Run locally

Run the below command to start the server:

npm start

Go to: http://localhost:3000

This project was bootstrapped with Create React App.

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 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 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.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify