Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added setup and deployment instructions
  • Loading branch information
3milyfz authored Nov 16, 2023
1 parent 57dfe57 commit 4ba8edd
Showing 1 changed file with 30 additions and 42 deletions.
72 changes: 30 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,35 @@
# Getting Started with Create React App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Development Setup

### Prerequisites

Make sure you have the following installed:

- Node.js and npm: [Download and Install Node.js](https://nodejs.org/)
- Git: [Download and Install Git](https://git-scm.com/)

### Clone the Repository

```bash
git clone https://github.com/your-username/https://github.com/Callhub-Connect/callhub-frontend.git
```

### Install Dependencies
```bash
npm install
```

### Run the Development Server
```bash
npm start # for mac
npm run start-pc # for pc
```
Visit http://localhost:3000 in your browser to view the app.

## Production Setup
Auto-deployment from GitHub is setup for Netlify at: https://callhub.netlify.app/

## Available Scripts

In the project directory, you can run:
Expand Down Expand Up @@ -32,43 +60,3 @@ The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/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.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](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](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](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](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](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

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

0 comments on commit 4ba8edd

Please sign in to comment.