feat: added README.md

Mannan-Goyal · Sep 9, 2021 · d3abef4 · d3abef4
1 parent d9384a2
commit d3abef4
Show file tree

Hide file tree

Showing 6 changed files with 256 additions and 41 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,65 @@
+# Contributing
+
+Thanks for contributing! :smile:
+
+The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+> Note: Contributions should be made via pull requests to the dev branch of the repository.
+
+## Table of Contents
+
+1. [Styleguides](#styleguides)
+2. [What should I know before I get started?](#what-should-i-know-before-i-get-started)
+3. [How Can I contribute?](#how-can-i-contribute)
+
+# Guidelines
+The following are the guidelines we request you to follow in order to contribute to this project.
+
+## Styleguides
+
+### Commit Messages
+
+The commit messages should follow the following pattern:
+```bash
+feat: Description # if a new feature is added
+fix: Description # if a bug is fixed
+refactor: Description # if code is refactored
+docs: Description # if documentation is added
+lint: Description # if a lint issue is fixed
+```
+### Issues
+
+```bash
+update: Description # if an update is required for a feature
+bug: Description # if there is a bug in a particular feature
+suggestion: Description # if you want to suggest a better way to implement a feature
+```
+### Code Styleguide
+The code should satisfy the following:
+  - Have meaningful variable names, either in `snake_case` or `camelCase`.
+  - Have no `lint` issues.
+  - Have meaningful file names, directory names and directory structure.
+  - Have a scope for easy fixing, refactoring and scaling.
+
+### Pull Requests
+Pull requests should have:
+  - A concise commit message.
+  - A description of what was changed/added.
+
+## What should I know before I get started
+You can contribute to any of the features you want, here's what you need to know:
+  - How the project works.
+  - The technology stack used for the project.
+  - A brief idea about writing documentation.
+
+## How Can I Contribute
+
+You can contribute by:
+  - Reporting Bugs
+  - Suggesting Enhancements
+  - Code Contribution
+  - Pull Requests
+
+Make sure to document the contributions well in the pull request.
+
+> It is not compulsory to follow the guidelines mentioned above, but it is strongly recommended.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Computer Society of India - VIT University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,70 +1,123 @@
-# Getting Started with Create React App
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+[![csivit][csivitu-shield]][csivitu-url]
+[![Issues][issues-shield]][issues-url]
 
-## Available Scripts
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/csivitu/Template">
+    <img src="https://csivit.com/images/favicon.png" alt="Logo" width="80">
+  </a>
 
-In the project directory, you can run:
+  <h3 align="center">Evie Frontend</h3>
 
-### `npm start`
+  <p align="center">
+    Event Calendar for VITians
+    <br />
+    <br />
+    <br />
+    <a href="https://evie.csivit.com">Visit Website</a>
+    ·
+    <a href="https://github.com/csivitu/Evie-frontend/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/csivitu/Evie-frontend/issues">Request Feature</a>
+  </p>
+</p>
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
 
-### `npm test`
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
 
-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.
+- [Table of Contents](#table-of-contents)
+- [About The Project](#about-the-project)
+  - [Built With](#built-with)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contributors](#contributors)
 
-### `npm run build`
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+<!-- ABOUT THE PROJECT -->
+## About The Project
+<p align="center">
+<img src="https://i.imgur.com/58cJF37.png" alt="Logo" width="100">
+</p>
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+![Product Name Screen Shot](https://i.imgur.com/0Pl0alg.png)
 
-### `npm run eject`
+Evie, a periodically updated calendar which can help clubs/chapters to let people know what they're up to, and students can keep up with events that suit their interests.
 
-**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.
+### Built With
 
-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.
+* React
+* Node & Express
+* MongoDB
 
-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
+<!-- USAGE EXAMPLES -->
+## Usage
 
-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)
+The students can visit [Evie](https://evie.csivit.com) and see upcoming events organised by various clubs and chapters and also visit registration wesites to register and know more about these events.
 
-### Making a Progressive Web App
+A PWA (Progressive Web App) is also available, users will be prompted to install it as soon as they open the website.
+You can use this PWA to keep track of events easily! 😄🎉
+<p align="center">
+<img src="https://i.imgur.com/eY6so6Z.png" alt="Logo" width="500">
+</p>
 
-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)
+The clubs/chapters can add their events in the calendar by filling up the [Event Form](https://evie.csivit.com/addevent).
 
-### 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)
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'feat: Add some AmazingFeature'`)
+4. Push to the Branch (`git push -u origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[csivitu-shield]: https://img.shields.io/badge/csivitu-csivitu-blue
+[csivitu-url]: https://csivit.com
+[issues-shield]: https://img.shields.io/github/issues/csivitu/Template.svg?style=flat-square
+[issues-url]: https://github.com/csivitu/Template/issues```[![csivit][csivitu-shield]][csivitu-url]
+[![Issues][issues-shield]][issues-url]
+//github.com/csivitu/Template/issues
+
+## Contributors
+
+Thanks goes to these wonderful people:
+
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/sanjaybaskaran01"><img src="https://avatars.githubusercontent.com/u/72266283?v=4" width="100px;" alt=""/><br /><sub><b>Sanjay Baskaran</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/Mannan-Goyal"><img src="https://avatars.githubusercontent.com/u/72966340?v=4" width="100px;" alt=""/><br /><sub><b>Mannan Goyal</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/ameeshagireesh"><img src="https://avatars.githubusercontent.com/u/67223373?v=4" width="100px;" alt=""/><br /><sub><b>Ameesha Gireesh</b></sub></a><br /></td>
+
+
+  </tr>
+</table>
diff --git a/public/index.html b/public/index.html
@@ -8,7 +8,7 @@
     <meta name="theme-color" content="#000000" />
     <meta
       name="description"
-      content="Web site created using create-react-app"
+      content="A periodically updated calendar that tells students about upcoming events at VIT and helps clubs and chapters reach a genuine audience for their events."
     />
     <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
 

diff --git a/src/pages/Home/index.jsx b/src/pages/Home/index.jsx
@@ -43,7 +43,7 @@ const Home = () => {
           swal({
             title: "Add Evie to Home Screen",
             buttons: {
-              Remember: "No and Remember!",
+              Remember: "Never!",
               "Nope!": true,
               "Yup!": true,
             },
@@ -56,7 +56,7 @@ const Home = () => {
       }
 
       function presentAddToHome() {
-        promptEvent.prompt(); // Wait for the user to respond to the prompt
+        promptEvent.prompt(); 
         promptEvent.userChoice.then((choice) => {
           if (choice.outcome === "accepted") {
             console.log("User accepted");