Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thekavikumar authored Feb 8, 2024
1 parent c032d88 commit 0e63e17
Showing 1 changed file with 39 additions and 54 deletions.
93 changes: 39 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,55 @@
# Getting Started with Create React App
# Tantrotsav

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Tantrotsav is a national techfest website aimed at bringing together students and tech enthusiasts from across the country to participate in various competitions, workshops, and events. This repository contains the code for the Tantrotsav website, featuring integration with the CCAvenue payment gateway and built using React.js for the frontend.

## Available Scripts
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

In the project directory, you can run:
## Features
- Seamless integration with the CCAvenue payment gateway for secure online transactions.
- User-friendly interface built with React.js for smooth navigation and interaction.
- Comprehensive information about competitions, workshops, and events offered during Tantrotsav.
- Easy registration process for participants to sign up for events and make payments.

### `npm start`
## Installation
To set up this project locally, follow these steps:

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
1. Clone the repository:

The page will reload when you make changes.\
You may also see any lint errors in the console.
```bash
git clone https://github.com/thekavikumar/tantrotsav.git
cd tantrotsav
```

### `npm test`
2. Install the required Node.js dependencies:

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.
```bash
npm install
```

### `npm run build`
3. Set up environment variables for CCAvenue integration. Refer to the `.env.example` file for required variables.

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
4. Start the development server:

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
```bash
npm start
```

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
5. Open your web browser and navigate to `http://localhost:3000` to view the website.

### `npm run eject`
## Usage
1. Explore the various sections of the website to learn about the competitions, workshops, and events offered.
2. Register for events by providing the necessary information and making payments securely through the integrated CCAvenue payment gateway.
3. Participate in Tantrotsav and enjoy the exciting lineup of activities!

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your improvements.

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.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

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)
Feel free to customize this template to better fit your project. Let me know if you need further assistance!

0 comments on commit 0e63e17

Please sign in to comment.