Skip to content

Commit 883b7de

Browse files
committed
Added README
1 parent 2b12da0 commit 883b7de

File tree

7 files changed

+72
-105
lines changed

7 files changed

+72
-105
lines changed

.firebase/hosting.YnVpbGQ.cache

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
asset-manifest.json,1616430657926,fbfb10cf88ca6518ad4abc0c88afa03b34a1621d78dd68bee3fd53328db9f71b
2+
logo192.png,1616430504831,76c449ccb9cd117c2f2338f091b18f7050f3210e249b2228f5c81b23f34377cd
3+
index.html,1616430657926,4e61f04433d045301980dd0ab97e6936b964e2377517e77cee6162bf58ff1c89
4+
manifest.json,1616430504835,0958a5e0c831126100c8c2d06a6bbaa665a3900f21aaff4130238a6f5a113aa1
5+
robots.txt,1616430504836,2544ca049f223a42bff01f72ad930a5edba75bbb7199d0f8430a02ff5aca16ec
6+
logo512.png,1616430504833,7779210d56c1f3741e2e487799fe3092def4fa6ac450a60532b807c3a8971205
7+
static/css/main.1a5822fc.chunk.css,1616430657929,afadd2abcc90add0d12109381734f2776becfe5af2c5b3519209dfa8eaacc51f
8+
static/js/2.683f2a76.chunk.js.LICENSE.txt,1616430657957,be3d091441dc3a51587eae8eafd9334c4697156c9d871b4073333fd282427d7d
9+
static/js/main.c2434601.chunk.js,1616430657930,3601f4185c460a7a7d22edeab38bc37341ca76508d94357a826e9f47131c3f3f
10+
static/js/runtime-main.3c153b28.js,1616430657956,48aff4bf8fd4bef79e7b2680cd23d6b2921ad7a8035e1a3998c07644c2ea6aa6
11+
static/css/main.1a5822fc.chunk.css.map,1616430657956,9a0dde8ca950f8c68eea5b0b606227553dfbb834cdc8a209d3c27a71c5fa6364
12+
static/js/runtime-main.3c153b28.js.map,1616430657958,957a79561366634fb56493216e9ec997dadb5aea0abe2fc03c58aaa128cff2de
13+
static/js/main.c2434601.chunk.js.map,1616430657957,80ccb34f2452e78cc660c404e58c506a00f4182f5aa598d76fcbd3344a8ec896
14+
favicon.ico,1616430504829,c599b7a91ab3627e3538125d9f40adc2d4bf949046984262670545dc7738af06
15+
static/js/2.683f2a76.chunk.js,1616430657975,dcb9b5d1b4a624f54b21449e5b606b8c98d8fa70613c8c0bc1bd255656b70ecb
16+
static/js/2.683f2a76.chunk.js.map,1616430658006,b926f35781e23086171ce56f73aad8f6ceccdbb08fa645c6ec62d71007750fa8

.firebaserc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"projects": {
3+
"default": "announceme-668a6"
4+
}
5+
}

AnnounceMe.gif

12.3 MB
Loading

README.md

+10-65
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,15 @@
1-
# Getting Started with Create React App
1+
<h1 align='center'>ANNOUNCEME</h1>
22

3-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3+
<p align='center'><img src="https://image.freepik.com/free-vector/smiling-man-talking-loudspeaker-monitor-social-media-computer-online-flat-vector-illustration-communication-digital-technology_74855-13238.jpg" /></p>
44

5-
## Available Scripts
5+
<p>AnnounceMe is an announcement portal. It allows users to login with their google accounts. After successfully loging in, a user have two options - Join a room or Create a room. If a user wants to join the room created by another user then he/she has to enter the <strong>Room Code</strong> that is generated after creating a room. Now, if a user creates a room, the room is given a unique id (i.e Room Code). Room code is used to join other people on that room. In a particular room, users can make any announcements or can start a discussion.</p>
66

7-
In the project directory, you can run:
7+
### Setting Up in a local system
8+
1. Clone this repository - ```git clone https://github.com/pranjals149/AnnounceMe.git```
9+
2. Move into the project directory - ```cd AnnounceMe```
10+
3. Install the required dependencies - ```npm i```
11+
4. Now, run the project - ```npm start```
812

9-
### `yarn start`
13+
### Working Screenshot
1014

11-
Runs the app in the development mode.\
12-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
13-
14-
The page will reload if you make edits.\
15-
You will also see any lint errors in the console.
16-
17-
### `yarn test`
18-
19-
Launches the test runner in the interactive watch mode.\
20-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
21-
22-
### `yarn build`
23-
24-
Builds the app for production to the `build` folder.\
25-
It correctly bundles React in production mode and optimizes the build for the best performance.
26-
27-
The build is minified and the filenames include the hashes.\
28-
Your app is ready to be deployed!
29-
30-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
31-
32-
### `yarn eject`
33-
34-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
35-
36-
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.
37-
38-
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.
39-
40-
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.
41-
42-
## Learn More
43-
44-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45-
46-
To learn React, check out the [React documentation](https://reactjs.org/).
47-
48-
### Code Splitting
49-
50-
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)
51-
52-
### Analyzing the Bundle Size
53-
54-
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)
55-
56-
### Making a Progressive Web App
57-
58-
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)
59-
60-
### Advanced Configuration
61-
62-
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)
63-
64-
### Deployment
65-
66-
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
67-
68-
### `yarn build` fails to minify
69-
70-
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)
15+
<img src="AnnounceMe.gif" />

firebase.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"hosting": {
3+
"public": "build",
4+
"ignore": [
5+
"firebase.json",
6+
"**/.*",
7+
"**/node_modules/**"
8+
],
9+
"rewrites": [
10+
{
11+
"source": "**",
12+
"destination": "/index.html"
13+
}
14+
]
15+
}
16+
}

public/index.html

+19-38
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,24 @@
11
<!DOCTYPE html>
22
<html lang="en">
3-
<head>
4-
<meta charset="utf-8" />
5-
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
6-
<meta name="viewport" content="width=device-width, initial-scale=1" />
7-
<meta name="theme-color" content="#000000" />
8-
<meta
9-
name="description"
10-
content="Web site created using create-react-app"
11-
/>
12-
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
13-
<!--
14-
manifest.json provides metadata used when your web app is installed on a
15-
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
16-
-->
17-
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
18-
<!--
19-
Notice the use of %PUBLIC_URL% in the tags above.
20-
It will be replaced with the URL of the `public` folder during the build.
21-
Only files inside the `public` folder can be referenced from the HTML.
223

23-
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
24-
work correctly both with client-side routing and a non-root public URL.
25-
Learn how to configure a non-root public URL by running `npm run build`.
26-
-->
27-
<title>React App</title>
28-
</head>
29-
<body>
30-
<noscript>You need to enable JavaScript to run this app.</noscript>
31-
<div id="root"></div>
32-
<!--
33-
This HTML file is a template.
34-
If you open it directly in the browser, you will see an empty page.
4+
<head>
5+
<meta charset="utf-8" />
6+
<link rel="icon"
7+
href="https://image.freepik.com/free-vector/smiling-man-talking-loudspeaker-monitor-social-media-computer-online-flat-vector-illustration-communication-digital-technology_74855-13238.jpg" />
8+
<meta name="viewport" content="width=device-width, initial-scale=1" />
9+
<meta name="theme-color" content="#000000" />
10+
<meta name="description" content="Web site created using create-react-app" />
11+
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
3512

36-
You can add webfonts, meta tags, or analytics to this file.
37-
The build step will place the bundled scripts into the <body> tag.
13+
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
3814

39-
To begin the development, run `npm start` or `yarn start`.
40-
To create a production bundle, use `npm run build` or `yarn build`.
41-
-->
42-
</body>
43-
</html>
15+
<title>AnnounceME</title>
16+
</head>
17+
18+
<body>
19+
<noscript>You need to enable JavaScript to run this app.</noscript>
20+
<div id="root"></div>
21+
22+
</body>
23+
24+
</html>

src/Components/JoinClass/JoinClass.js

+6-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { Close } from '@material-ui/icons'
33
import React from 'react'
44
import { useState } from 'react'
55
import { useLocalContext } from '../../context/context'
6-
import db from '../../lib/firebase'
6+
import db, { auth } from '../../lib/firebase'
77

88
import './JoinClass.css'
99

@@ -56,6 +56,10 @@ const JoinClass = () => {
5656
}
5757
}
5858

59+
const logout = () => {
60+
auth.signOut()
61+
}
62+
5963
return (
6064
<div>
6165
<Dialog
@@ -93,7 +97,7 @@ const JoinClass = () => {
9397
</div>
9498
</div>
9599

96-
<Button variant='outlined' color='primary'>
100+
<Button variant='outlined' color='primary' onClick={logout}>
97101
Logout
98102
</Button>
99103
</div>

0 commit comments

Comments
 (0)