Fellowship Finder is a web app that allows users to find and meet people with similar interests in games.
The app allows users to create profiles, filter through other users based on interests and meetup logistics, add friends, and plan events. Fellowship Finder is meant to provide a platform for people to make friends with shared interests and streamline the process of organizing tabletop sessions.
Events Calendar: you can put in your location and friends to invite. This data not only creates a pin on the map, but also creates a chatroom for the event participants to talk to each other. Users can also upload photos for the event.
Character Creator: Create a character sheet for your next adventure! You can input the states, class and race of your next character and see the stats generated in a spider graph.
Posting Board: Users can Post requests as well as edit, delete and up vote requests.
Photo Sharing: Post photos from your the event you have attended or hosted
Chat: Communicate in real time with other members of the events you are hosting or invited to
-
If you don’t have Node.js installed, install it from here. (We used Node v18.16.0 and have not tested on other versions)
-
Clone this repository and navigate into the project directory
-
Install the requirements
npm install
NOTE ABOUT GOOGLE OAUTH - WE HAVE REMOVEED THIS FEATURE AND ARE ONLY USING THE LOCAL STRATEGY SO YOU DONT NEED TO SET THIS UP UNLESS YOU WANT TO
-
Make an account or sign in the Google Cloud.
-
Navigate to the credentials section of the API's and services.
-
Create a OAuth client ID credential. Name it whatever you like. For Application type select Web application.
-
Add the following Authorized origins:
http://localhost:8080
http://localhost:3001
- Add the following redirect URI's:
http://localhost:3001/auth/google/redirect
http://localhost:8080/auth/google/callback
-
Make a copy of the .env.example and re-name as .env
-
Inside of the new .env file, replace the empty strings with your new Google Oauth Client ID and Client secret. The session cookieKey can be named whatever you like.
-
Make a Cloudinary account
-
Navigate to your dashboard and copy over the API Key, API Secret, and Cloudinary URL into the respective sections of the your .env
-
Run the app
npm run dev
- You should now be able to access the app at http://localhost:3001
Assuming you're using AWS EC2 Ubuntu instance you're going to:
-
Install nvm and npm
-
Install mysql and set password for mysql (https://www.digitalocean.com/community/tutorials/how-to-install-mysql-on-ubuntu-20-04) Don't do secure install
-
Run export command for the environment variables listed: CLOUDINARY_URL= >whatever youre cloudinary url is< API_SECRET= >whatever your cloudinary api secret is< API_KEY=>whatever your cloudinary api key is< GOOGLE_CLIENT_ID=>whatever your google client id is< GOOGLE_CLIENT_SECRET=>whatever your google client secret is<
-
Run scripts: Npm run build-short Npm run start-short Make sure console logs ‘Connected to database!’
(Make sure youre running the 'short' so the build doesn't freeze!)
Emmy Bishop @emmy-bishop
Kalypso Homan @catcatmcgee
Marvas McCladdie @MarvyWarvy
AJ Bell
Geremy Fisher
Evan Perry
Sydney Andre
James Sheppard
Node: v20.9.0
Database: mySQL
ORM: Sequelize
HTTP Client: Axios
Deployment site: AWS
Server: Express
Authentication: Passport and Google auth
Client: React
Styling: Material-UI
Calendar UI: Big React Calendar
Project management: Trello
Cloud based Media Storage: Cloudinary
Interactive Map API: MapBox
Websocket: socket.io
Data Visualization Library: Chart.js
The sign up page will take in your info but sometimes it will not send you to the user page.
You can refresh the page or you can type /home at the end of the URL to advance into the site.
Refreshing may change context for logged in user to a different user.
Running seed may cause conflicts with actual Data Models.
Adding yourself to an event will cause duplicate chat rooms.
Can't add yourself to an event if you want to add an photo.
May load duplicates of certain resources (login page, emotion/react)
This project is licensed under the VERYREALVERYSECURE License.