Skip to content

Commit

Permalink
Modified README.md and added LICENSE.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
jjacobsonn committed Jun 28, 2024
1 parent 3ca2c2c commit 6b575b3
Show file tree
Hide file tree
Showing 3 changed files with 143 additions and 18 deletions.
9 changes: 9 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Custom Restrictive License

Copyright (c) 2024 Jackson Jacobson - The Excellence & Innovation Initiative (e2i)

Permission to use, copy, modify, and/or distribute this software for any purpose is hereby prohibited without express written permission from the copyright holder.

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.

For permission requests, please contact `[email protected]`.
152 changes: 134 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/your_username/repo_name">
<img src="../uvu-study-groups/public/images/UVUComboOverWolverinesWhite-0040.png.png" alt="Logo" width="80" height="80">
<a href="https://github.com/jjacobsonn/uvu-studygroups-frontend">
<img src="./public/images/UVUComboOverWolverinesWhite-0040.png" alt="Logo" width="80" height="80">
</a>

<h3 align="center">UVU Study Groups</h3>
Expand Down Expand Up @@ -60,61 +60,167 @@
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>

<!-- ABOUT THE PROJECT -->
## About The Project

[![Product Name Screen Shot][product-screenshot]](./public/images/ss-README.png)
[![UVU Study Groups Screenshot](./public/images/ss-README.png)](https://example.com)

This project is designed to help students at Utah Valley University (UVU) find and create study groups. It aims to foster collaboration and enhance learning experiences by making it easier for students to connect with peers who share similar academic interests.
UVU Study Groups is a web application developed as part of Utah Valley University's (UVU) Excellence & Innovation Initiative (e2i) program. This platform is designed to facilitate the creation, discovery, and management of study groups for UVU students, leveraging modern web technologies and integration with popular communication platforms.

Here's why:
* Focus on creating amazing study groups
* Save time by not having to manually coordinate group meetings
* Enhance collaboration through easy-to-use interface
### Key Features

<p align="right">(<a href="#readme-top">back to top</a>)</p>
- **User Authentication**: Secure login and signup functionality, with Discord integration for seamless access
- **Study Group Management**: Tools for creating, searching, and joining public study groups
- **Discord Integration**: Automatic server creation and member management for each study group
- **Intuitive User Interface**: A clean, responsive design optimized for both desktop and mobile devices

### Benefits

- **Enhanced Collaboration**: Facilitates easier connection between students with shared academic interests
- **Time Efficiency**: Reduces the overhead of manually coordinating study sessions
- **Improved Learning Outcomes**: Encourages peer-to-peer learning and knowledge exchange
- **University Integration**: Designed specifically for UVU students, aligning with university programs and initiatives

### Built With

* [![React][React.js]][React-url]
* [![TailwindCSS][TailwindCSS.com]][TailwindCSS-url]
* [![Express][Express.js]][Express-url]
* [![JavaScript][JavaScript.com]][JavaScript-url]
* [![CSS][CSS.com]][CSS-url]
* [![MySQL][MySQL.com]][MySQL-url]

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- FIGMA DESIGN -->
## Figma Design Documentation
[![Figma UVU Study Groups ScreenShot](./public/images/figma-rm.png)](https://example.com)

The design for UVU Study Groups was created in Figma. It includes both desktop and mobile layouts for the following pages:
- Home
- Sign Up
- Login
- Join Study Group
- Create Study Group

You can view the detailed Figma design here:
[UVU Study Groups Figma Design](https://www.figma.com/design/ym37iW2znUsgLhKauQ1bqv/UVU-Study-Groups---e2i?m=auto&t=lq7FYnXMh2zOMXNN-6)

<p align="right">(<a href="#readme-top">back to top</a>)</p>


<!-- GETTING STARTED -->
## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

You need to have Node.js and npm installed.
You need to have Node.js, npm, and TailwindCSS installed.

* npm
```sh
npm install npm@latest -g

<!-- MARKDOWN LINKS & IMAGES -->
* TailwindCSS
```sh
npm install -D tailwindcss
### Installation
1. Clone the repository:
```sh
git clone https://github.com/jjacobsonn/uvu-studygroups-frontend.git
```
2. Install application dependencies:
```sh
cd uvu-study-groups
npm install
```
3. Run the development server:
```sh
npm start
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>


### Usage
* Navigate to `http://localhost:3000` to use the application locally.

<p align="right">(<a href="#readme-top">back to top</a>)</p>


### Roadmap
- [x] Create GitHub Repo for Onboarding Project Members
- Frontend Roadmap
- [x] Created Figma Outlining Main Application Pages
- [x] Created `Home Page` + Components
- [ ] Create Main Footer
- [ ] Create and implement `Sign Up` Page
- [ ] Create and implement `Login` Page
- [ ] Create and implement `Join Study Group` Page
- [ ] Create and implement `Create Study Group` Page
- [ ] Implement Mobile App Version
- Backend Roadmap
- [ ] Add User Authentication
- [ ] Integrate Discord OAuth2
- [ ] Add Notification System
- [ ] Implement Backend DB for Study Groups

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/YourFeatureContribution`)
3. Commit your Changes (`git commit -m 'Add some YourFeatureContribution'`)
4. Push to the Branch (`git push origin feature/YourFeatureContribution`)
5. Open a Pull Request
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## License
This project is licensed under a Custom Restrictive License. See the [LICENSE](LICENSE.txt) file for more details.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
GitHub Owner: **Jackson Jacobson**
Twitter - [@jackson_swe](https://x.com/jackson_swe)
Email - [email protected]
LinkedIn: [https://www.linkedin.com/in/jjacobsonn/](https://www.linkedin.com/in/jjacobsonn/)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[contributors-url]: https://github.com/jjacobsonn/uvu-studygroups-frontend/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
[forks-url]: https://github.com/jjacobsonn/uvu-studygroups-frontend/forks
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
[stars-url]: https://github.com/jjacobsonn/uvu-studygroups-frontend/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
[issues-url]: https://github.com/jjacobsonn/uvu-studygroups-frontend/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[linkedin-url]: https://www.linkedin.com/in/jjacobsonn/
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
Expand All @@ -131,4 +237,14 @@ You need to have Node.js and npm installed.
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com
[JQuery-url]: https://jquery.com
[TailwindCSS.com]: https://img.shields.io/badge/TailwindCSS-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white
[TailwindCSS-url]: https://tailwindcss.com/
[Express.js]: https://img.shields.io/badge/Express-000000?style=for-the-badge&logo=express&logoColor=white
[Express-url]: https://expressjs.com/
[JavaScript.com]: https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black
[JavaScript-url]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
[CSS.com]: https://img.shields.io/badge/CSS-1572B6?style=for-the-badge&logo=css3&logoColor=white
[CSS-url]: https://developer.mozilla.org/en-US/docs/Web/CSS
[MySQL.com]: https://img.shields.io/badge/MySQL-4479A1?style=for-the-badge&logo=mysql&logoColor=white
[MySQL-url]: https://www.mysql.com/
Binary file added public/images/figma-rm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b575b3

Please sign in to comment.