Skip to content

Commit 13e9538

Browse files
Merge pull request #62 from charviupreti/update-readme
Update README (fix #4).md
2 parents dabbe2f + 57d8317 commit 13e9538

File tree

1 file changed

+61
-15
lines changed

1 file changed

+61
-15
lines changed

README.md

Lines changed: 61 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,77 @@
1-
# ACM FUN
1+
# ACM FUN - React.js Project
22

3-
An initiative by PECACM for engaging beginners in development to some open source contributions :)
3+
ACM FUN is an exciting initiative by PECACM, aimed at engaging beginners in the world of development and open source contributions. 😄
44

5-
## Available Scripts
5+
Live URL:- https://acm-fun.vercel.app/
66

7-
In the project directory, you can run:
7+
## Table of Contents
88

9-
### `npm start`
9+
- [Description](#acm-fun---reactjs-project)
10+
- [Features](#features)
11+
- [Tech Used](#tech-used)
12+
- [How to start](#how-to-start)
13+
- [Contributing](#contributing)
1014

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
15+
## Features
1316

14-
The page will reload when you make changes.\
15-
You may also see any lint errors in the console.
17+
- A fun and interactive web application built using React.js.
18+
- Engage with open source contributions in a beginner-friendly environment.
19+
- Collaborate with a community of like-minded individuals.
1620

17-
### `npm run build`
21+
## Tech Used
1822

19-
Builds the app for production to the `build` folder.\
20-
It correctly bundles React in production mode and optimizes the build for the best performance.
23+
React is a JavaScript library for building fast and interactive UIs.
2124

22-
The build is minified and the filenames include the hashes.\
23-
Your app is ready to be deployed!
25+
Vercel is a cloud platform for deploying and scaling React applications.
2426

25-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
27+
## How to start
28+
29+
1. Clone the repository
30+
31+
```
32+
git clone https://github.com/PEC-CSS/acm-fun.git
33+
```
34+
35+
2. Change the working directory
36+
37+
```
38+
cd acm-fun
39+
```
40+
41+
3. Install dependencies
42+
43+
```
44+
npm install
45+
```
46+
47+
4. Run the app
48+
49+
```
50+
npm start
51+
```
52+
53+
5. Open your web browser and navigate to http://localhost:3000 to view the app.
54+
55+
The page will automatically reload when you make changes, and any lint errors will be displayed in the console.
56+
57+
6. To build for production use the command:
58+
59+
```
60+
npm run build
61+
```
62+
63+
This command bundles React in production mode and optimizes the build for the best performance. The build is minified, and the filenames include hashes. Once the build process is complete, your app is ready to be deployed.
64+
65+
# Contributing
66+
67+
- To contribute to ACM FUN, refer to [Contributing Guidlines](./Contributing.md)
2668

2769
# Contributors
2870

2971
<a href="https://github.com/PEC-CSS/acm-fun/graphs/contributors">
3072
<img src="https://contrib.rocks/image?repo=PEC-CSS/acm-fun" />
3173
</a>
74+
75+
<br>
76+
77+
We welcome your contributions and hope you enjoy your journey with ACM FUN!

0 commit comments

Comments
 (0)