-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6fc5d39
commit 392b8f8
Showing
1 changed file
with
46 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,72 @@ | ||
| # Getting Started with Create React App | ||
| # PledgeUp | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| PledgeUp is a crowdfunding platform for creative projects. | ||
|
|
||
| ## Available Scripts | ||
| <img width="753" alt="pledgeup" src="https://github.com/Ratnesh4193/PledgeUp/assets/57043581/5f5e2667-a7b1-4f16-b835-19de5cf4a6b1"> | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| ### `npm start` | ||
| ## Table of Contents | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
| - [Features](#features) | ||
| - [Getting Started](#getting-started) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Contributing](#contributing) | ||
|
|
||
| The page will reload when you make changes.\ | ||
| You may also see any lint errors in the console. | ||
| ## Features | ||
|
|
||
| ### `npm test` | ||
| - Create and manage crowdfunding projects. | ||
| - Backers can pledge funds to projects. | ||
| - Project creators can set funding goals and deadlines. | ||
| - Explore and discover a variety of creative categories. | ||
| - Real-time project updates. | ||
|
|
||
| Launches the test runner in the interactive watch mode.\ | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
| ## Getting Started | ||
|
|
||
| ### `npm run build` | ||
| ### Prerequisites | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
| Before you start, make sure you have the following software installed: | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
| - Node.js | ||
| - npm | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
| ### Installation | ||
|
|
||
| ### `npm run eject` | ||
| 1. Clone the repository: | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can't go back!** | ||
| ```sh | ||
| git clone https://github.com/Ratnesh4193/PledgeUp.git | ||
|
|
||
| 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. | ||
| 2. Navigate to the project directory: | ||
|
|
||
| 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. | ||
| ```sh | ||
| cd PledgeUp | ||
| 3. Install dependencies: | ||
| 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. | ||
| ```sh | ||
| npm install | ||
|
|
||
| ## Learn More | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
| ### Usage | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
| 1. Start the development server: | ||
|
|
||
| ### Code Splitting | ||
| ```sh | ||
| npm start | ||
| 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) | ||
| 2. Open your browser and navigate to: | ||
| ### Analyzing the Bundle Size | ||
| ```sh | ||
| (http://localhost:3000/) | ||
| 3. You can now explore and use PledgeUp. | ||
|
|
||
| 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 | ||
| Contributing | ||
| We welcome contributions from the community. To contribute to PledgeUp, follow these steps: | ||
|
|
||
| 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) | ||
| 1. Fork the repository. | ||
| 2. Create a new branch for your feature: git checkout -b feature-name | ||
| 3. Make your changes and commit them: git commit -m 'Add some feature' | ||
| 4. Push to your fork: git push origin feature-name | ||
| 5. Create a pull request to the main branch of the original repository. |