-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implemented preliminary setup description for READ ME file.
- Loading branch information
1 parent
4de5082
commit 11ca6fa
Showing
1 changed file
with
82 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,84 @@ | ||
| # In Development | ||
|
|
||
| <div> | ||
| <!--<a href="https://github.com/github_username/repo_name"> | ||
| <!--add the link to the image here | ||
| <img src="github-image-readme.jpg" alt="Logo" width="200" height="200"> | ||
| </a> --> | ||
|
|
||
| <h1>CCNY Schedule Pro</h1> | ||
|
|
||
| <h3> | ||
| <b>Description</b><br /> | ||
| </h3> | ||
| <p>A project that has been development as part of my senior design 2 course. The intention of this is to replace the dependency on rate my professor, as well as provide features similar to discord as well as Google Calendar. While students can not only create their schedule, set reminders, notification alerting system, but they can also see up-to-date information regarding the classes being offered in each particular semester, filtered by depaertments that they are affiliated with, list of teachers as well as classes filtered based on the teachers specifically. Additionally, students can also see the most recent comments from Rate my Professor regarding a particular professor, allowing them to gain a better understanding of the teaching style of the professor, the class difficulty, to enable improved decision making as to whether or not they should move forward with the plan of taking this class.</p><br/> | ||
| Students can also communicate within department groupchats, communicate privately amongst one another, share resoruces with one another. Unfortunately, the project is still early in development and is currently we are behind the expected schedule due to being overhwhelmed with classes, job search, and other obligations, leaving very little time to work on it, however, as the owner of this project, I will continue working on it during whichever free time I can set aside and ensure that this project can be pushed into production, it may take 1-2 additional years to clean things up and ensure I am able to provide satisfactory results, but the hope is that this is a potential app that can be marketed for CCNY students, this is my way of giving back to the college that has provided me with the education I needed for the career I wished to pursue. | ||
| <br /><br /> | ||
| <b> | ||
| <p>Following Are Links for Contact, to report Bugs and if you would like a new feature or Contribute:</p></b> | ||
| <p><b>Email:</b> [email protected]</p> | ||
| <p><b>Discord:</b> the1sand0s</p> | ||
| </p> | ||
| </div> | ||
|
|
||
|
|
||
| ### Built With | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
| *  | ||
|
|
||
| ## Getting Started | ||
| If you would like to locally rn the project, please follow the instructions below | ||
|
|
||
| ### Prerequisites | ||
| Ensure that npm's version is up to date (**NOTE** : Your not limited to npm only (**Recommended** : Yarn)) | ||
| * npm | ||
| ```sh | ||
| npm install npm@latest -g | ||
| ``` | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Setup your bot and retrieve it's token following the guide and add the server to a server for testing [Setup Instructions](https://discordjs.guide/preparations/setting-up-a-bot-application.html) | ||
| 2. Clone the repo | ||
| ```sh | ||
| git clone https://github.com/DeveloperMindset123/CCNY_SchedulePro.git | ||
| ``` | ||
| 3. Install the packages | ||
| ```sh | ||
| yarn install | ||
| ``` | ||
| 4. Enter the following values in `.env` (Modify as needed) | ||
| <b>NOTE</b>: If you need help regarding setting up postgres, please refer to the following link, prisma is the middleware that connects the React-Native project with the Postgres Database (<i>Reference</i> : [prisma+postgres_setup](https://www.prisma.io/docs/orm/overview/databases/postgresql)), also, the encryption and decryption key should remain the same, otherwise, it will not work. | ||
| ```basic | ||
| DATABASE_URL="your postgres SQL database URL" | ||
| JWT_ACCESS_SECRET=ANY_RANOMD_SECRET_KEY_DONT_SHARE | ||
| JWT_REFRESH_SECRET=ANY_RANDOM_REFRESH_SECRET_DONT_SHARE | ||
| ENCRYPTION_KEY=SOME_ENRYPTION_KEY | ||
| DECRYPTION_KEY=SOME_ENCRYPTION_KEY | ||
| ``` | ||
| 6. Change git remote url to avoid accidental pushes to base project | ||
| ```sh | ||
| git remote set-url origin github_username/repo_name | ||
| git remote -v # confirm the changes | ||
| ``` | ||
|
|
||
|
|
||
| ### Screenshots (of current project) | ||
| <img src="" width="250"/> | ||
| <img src="" width="250"/> | ||
| <img src="" width="250"/> | ||
| <img src="" width="250"/> | ||
| <img src="" width="250"/> | ||
| <img src="" width="250"/> | ||
| <img src="" width="250"/> | ||
| <img src="" width="250"/> |