An interplanetary town square that maintains connections between cultures and ideologies of colonies across the galaxy.
- Kamal Dolikay
- GitHub: @kamalkdolikay
- Email: [email protected]
- Ole Lammers
- GitHub: @zyrakia
- Email: [email protected]
- Tianyou Xie
- GitHub: @Tianyou-Xie
- Email: [email protected]
- Samarjit Bhogal
- GitHub: @SamarjitBhogal
- Email: [email protected]
- Marcus Lages
- GitHub: @MarcusLages
- Email: [email protected]
- Create Account and Login (Email/Password or Google)
- Delete Account and Logout
- Edit Account
- Edit Profile
- View Available Planets
- Map Mode
- List Mode
- Create Posts on Various Planets
- View Posts
- Galactic Feed
- Planetary Feed
- User Feed
- Interact with Posts
- Comment
- Like / Unlike
- Save / Unsave
- Share
- Change Avatar
- Search for Posts
- Search for Users
- Interact with Users
- Follow / Unfollow
- Message (real-time)
- View Interactions
- Saved Posts
- Liked Posts
- Following
- Followers
- View Privacy Policy
- View Terms of Use
- View FAQs
The project is built using Typescript, and split into two modules, the client and server.
Client (built with Vite):
- React
- React Bootstrap
- React Icons
- Wouter
- CSS Modules (implemented by Vite)
- Bootstrap
- axios
- dotenv
- React If
- React Toastify
- Socket IO (Client)
- Popper
- Axios
- Axios Cache
- Is Mobile
- Konva
- React Helmet
- Use Image
Server (built with esno):
- Node
- MongoDB connected by mongoose
- Express
- Express File Routing
- Joi
- bcrypt
- HTTP Status Codes
- Nodemailer
- JWT
- CORS
- dotenv
- Google Auth Library
- Google APIs
- Socket IO (Server)
- Cloudinary
- OpenAI
- UUID
Development Utilities:
- Prettier for consistent code formatting, see
.prettierrc. - morgan for request logging
- picocolors for adding colour to request logging
- Regex Escape Utility: (
./server/src/utils/regex.ts:10)https://github.com/component/escape-regexp/blob/master/index.js
- Helmet SEO Component Structure: (
./client/src/components/seo/seo.tsx) - Hotbar Structure and Animation Inspiration: (
./client/src/components/Hotbar/Hotbar.tsx) - Customized React Toast: (
./client/src/index.css) - Planet Map Orbit Calculations (
./client/src/pages/planet-map/planet-visual.tsx)
Both the server and client utilize a .env file.
|.
├── client/
│ └── .env -- client environment variables (injected by Vite)
└── server/
└── .env -- server environment variables (injected by dotenv)
Client Variables:
| Key | Usage |
|---|---|
| VITE_PORT | The port that Vite serves the client on, when running locally |
| VITE_SERVER_PORT | The port that the server is running on, when running locally |
| VITE_NODE_ENV | The environment the client is running in (development_local / development / production) |
Server Variables:
| Key | Usage |
|---|---|
| PORT | The port that Express starts the server on, when running locally |
| CLIENT_PORT | The port that the client is being served on, when running locally |
| NODE_ENV | The environment the server is running in (development_local / development / production) |
| MONGO_URL | The MongoDB connection string used to connect to the database |
| JWT_SECRET | The secret used to sign and verify JWT tokens |
| JWT_TTL | The JWT token expiry time, in seconds |
| GOOGLE_OAUTH_ID | The Google OAuth API Client ID used to authenticate with Google |
| GOOGLE_OAUTH_SECRET | The Google OAuth API Client Secret used to authenticate with Google |
| EMAIL_HOST | The hostname of the email transporter used to send emails from the server |
| EMAIL_PORT | The port of the email transporter used to send emails from the server |
| EMAIL_USER | The username of the email transporter used to send emails from the server |
| EMAIL_PASS | The password of the email transporter used to send emails from the server |
| CLOUDINARY_CLOUD_NAME | The Cloudinary cloud name used to upload images |
| CLOUDINARY_CLOUD_KEY | The Cloudinary cloud API key used to upload images |
| CLOUDINARY_CLOUD_SECRET | The Cloudinary cloud API secret used to upload images |
| OPENAI_API_KEY | The OpenAI API key used to generate images |
Running the Server:
- Ensure you have all server environment variables set
- Enter the server directory (
cd server) - Ensure all dependencies are installed (
npm i) - Launch the server in regular (
npm start) or watch mode (npm run dev)
The server does not compile, it runs as a Node app. In order to deploy it, you must deploy the server folder and run the npm start command inside the deployed folder.
Running the Client:
- Ensure you have all client environment variables set
- Enter the client directory (
cd client) - Ensure all dependencies are installed (
npm i) - Launch the client in preview (
npm start) or watch mode (npm run dev)
The client compiles to a dist folder (npm run build). This folder can be deployed as a static site. Because this project uses client side navigation, you must ensure the service you are using to deploy the client has a rewrite rule to rewrite all requests to the / route. If request URLs are not rewritten by the deployment service, the client side routing will not be able to display the correct page when loading the page from a URL that does not point to the / route.
There are a few instances where AI was used in this project:
- Default Avatars - when a user signs up, an avatar is automatically generated for them using AI
- Policy Page - an inital draft was created with the help of ChatGPT
- Terms of Use Page - an inital draft was created with the help of ChatGPT
- FAQs Page - ChatGPT was use to get an idea of common questions that people have about social media platforms
- Planet Images - the images on the homepage for the different planets were generated with AI and then edited manually to enhance the look and feel
Files and Folders (as of commit 9720d71)
.
├── .gitignore
├── .prettierrc
├── .vscode
│ ├── extensions.json
│ └── settings.json
├── README.md
├── Skynet Logo.png
├── client
│ ├── index.html
│ ├── package-lock.json
│ ├── package.json
│ ├── public
│ │ ├── among-us.jpg
│ │ ├── among-us2.jpg
│ │ ├── favicon.ico
│ │ └── logo.webp
│ ├── src
│ │ ├── app.tsx
│ │ ├── assets
│ │ │ ├── fonts
│ │ │ │ ├── BITSUMIS.TTF
│ │ │ │ ├── BabaPro-Bold.ttf
│ │ │ │ ├── FjallaOne-Regular.ttf
│ │ │ │ └── TT-Octosquares-Trial-Regular.ttf
│ │ │ ├── images
│ │ │ │ ├── amongus-black.webp
│ │ │ │ ├── amongus-blue.webp
│ │ │ │ ├── amongus-green.webp
│ │ │ │ ├── amongus-pink.webp
│ │ │ │ ├── amongus-red.webp
│ │ │ │ ├── amongus-white.webp
│ │ │ │ ├── amongus-yellow.webp
│ │ │ │ ├── icons
│ │ │ │ │ ├── android-chrome-192x192.png
│ │ │ │ │ ├── android-chrome-512x512.png
│ │ │ │ │ ├── apple-touch-icon.png
│ │ │ │ │ ├── favicon-16x16.png
│ │ │ │ │ ├── favicon-32x32.png
│ │ │ │ │ ├── favicon.ico
│ │ │ │ │ └── site.webmanifest
│ │ │ │ └── skynet-logo.png
│ │ │ └── videos
│ │ │ ├── home.gif
│ │ │ ├── message.gif
│ │ │ └── post.gif
│ │ ├── components
│ │ │ ├── google-auth-btn
│ │ │ │ └── google-auth-btn.tsx
│ │ │ ├── header
│ │ │ │ ├── header.module.css
│ │ │ │ └── header.tsx
│ │ │ ├── hotbar
│ │ │ │ ├── hotbar-animation.css
│ │ │ │ ├── hotbar.module.css
│ │ │ │ └── hotbar.tsx
│ │ │ ├── loader
│ │ │ │ ├── loader.module.css
│ │ │ │ ├── loader.tsx
│ │ │ │ ├── small-loader.module.css
│ │ │ │ └── small-loader.tsx
│ │ │ ├── modal-confirmation
│ │ │ │ ├── modal-confirmation.module.css
│ │ │ │ └── modal-confirmation.tsx
│ │ │ ├── page
│ │ │ │ ├── page.module.css
│ │ │ │ └── page.tsx
│ │ │ ├── paginated-post-feed
│ │ │ │ └── paginated-post-feed.tsx
│ │ │ ├── paginated-user-list
│ │ │ │ ├── paginated-user-list.module.css
│ │ │ │ └── paginated-user-list.tsx
│ │ │ ├── post
│ │ │ │ ├── post-header
│ │ │ │ │ ├── post-header.module.css
│ │ │ │ │ └── post-header.tsx
│ │ │ │ ├── post.module.css
│ │ │ │ └── post.tsx
│ │ │ ├── profile
│ │ │ │ ├── profile.module.css
│ │ │ │ └── profile.tsx
│ │ │ ├── ques-accordion
│ │ │ │ ├── ques-accordion.module.css
│ │ │ │ └── ques-accordion.tsx
│ │ │ ├── scrambler
│ │ │ │ └── scrambler.tsx
│ │ │ ├── seo
│ │ │ │ └── seo.tsx
│ │ │ └── uibox
│ │ │ ├── uibox.module.css
│ │ │ └── uibox.tsx
│ │ ├── environment.ts
│ │ ├── index.css
│ │ ├── index.tsx
│ │ ├── lib
│ │ │ ├── auth.ts
│ │ │ ├── axios.ts
│ │ │ ├── callPosts.ts
│ │ │ ├── create-slug.ts
│ │ │ ├── is-user.ts
│ │ │ └── with-ref.ts
│ │ ├── pages
│ │ │ ├── about
│ │ │ │ ├── about-page.module.css
│ │ │ │ ├── about-page.tsx
│ │ │ │ └── options
│ │ │ │ ├── about-page.tsx
│ │ │ │ ├── policy-page.tsx
│ │ │ │ └── terms-page.tsx
│ │ │ ├── create-post
│ │ │ │ ├── create-post.module.css
│ │ │ │ └── create-post.tsx
│ │ │ ├── edit-profile-page
│ │ │ │ ├── edit-profile-page.module.css
│ │ │ │ └── edit-profile-page.tsx
│ │ │ ├── faqs
│ │ │ │ ├── faqs-page.tsx
│ │ │ │ └── faqs.module.css
│ │ │ ├── follower
│ │ │ │ ├── follower.module.css
│ │ │ │ └── follower.tsx
│ │ │ ├── following
│ │ │ │ ├── following.module.css
│ │ │ │ └── following.tsx
│ │ │ ├── forgot-password
│ │ │ │ ├── forgot-password.module.css
│ │ │ │ └── forgot-password.tsx
│ │ │ ├── general-feed
│ │ │ │ ├── general-feed.module.css
│ │ │ │ └── general-feed.tsx
│ │ │ ├── home
│ │ │ │ ├── planet-list-entry.tsx
│ │ │ │ ├── planet-list.module.css
│ │ │ │ └── planet-list.tsx
│ │ │ ├── landing-page
│ │ │ │ ├── landing-page.module.css
│ │ │ │ └── landing-page.tsx
│ │ │ ├── login
│ │ │ │ ├── login-component.tsx
│ │ │ │ ├── login-html.tsx
│ │ │ │ └── login.module.css
│ │ │ ├── messages-all
│ │ │ │ ├── messages.module.css
│ │ │ │ └── messages.tsx
│ │ │ ├── messages
│ │ │ │ ├── messages-component.tsx
│ │ │ │ ├── messages-html.tsx
│ │ │ │ └── messages.module.css
│ │ │ ├── page404
│ │ │ │ ├── page404.module.css
│ │ │ │ └── page404.tsx
│ │ │ ├── planet-feed
│ │ │ │ ├── planet-feed.module.css
│ │ │ │ └── planet-feed.tsx
│ │ │ ├── planet-map
│ │ │ │ ├── center-visual.tsx
│ │ │ │ ├── decorative-star.tsx
│ │ │ │ ├── planet-info-card.tsx
│ │ │ │ ├── planet-map.tsx
│ │ │ │ ├── planet-visual.tsx
│ │ │ │ ├── space-traveller.tsx
│ │ │ │ └── star-background.tsx
│ │ │ ├── planets
│ │ │ │ ├── planets-component.tsx
│ │ │ │ ├── planets-html.tsx
│ │ │ │ └── planets.module.css
│ │ │ ├── post-details
│ │ │ │ ├── post-details.module.css
│ │ │ │ └── post-details.tsx
│ │ │ ├── profile-page
│ │ │ │ ├── profile-page.module.css
│ │ │ │ └── profile-page.tsx
│ │ │ ├── reset-password
│ │ │ │ ├── reset-password.module.css
│ │ │ │ └── reset-password.tsx
│ │ │ ├── search-page
│ │ │ │ ├── search-page.module.css
│ │ │ │ └── search-page.tsx
│ │ │ ├── signup
│ │ │ │ ├── signup-component.tsx
│ │ │ │ ├── signup-html.tsx
│ │ │ │ └── signup.module.css
│ │ │ ├── support-page
│ │ │ │ ├── support-page.module.css
│ │ │ │ └── support-page.tsx
│ │ │ ├── user-page
│ │ │ │ ├── user-page.module.css
│ │ │ │ └── user-page.tsx
│ │ │ └── user-settings
│ │ │ ├── options
│ │ │ │ ├── change-email-modal.tsx
│ │ │ │ ├── change-password-modal.tsx
│ │ │ │ ├── change-username-modal.tsx
│ │ │ │ ├── commented.tsx
│ │ │ │ ├── delete-account-modal.tsx
│ │ │ │ ├── liked.tsx
│ │ │ │ ├── manage-account-page.tsx
│ │ │ │ ├── saved.tsx
│ │ │ │ └── your-info-modal.tsx
│ │ │ ├── user-settings-page.module.css
│ │ │ └── user-settings-page.tsx
│ │ └── vite-env.d.ts
│ ├── tsconfig.json
│ └── vite.config.ts
└── server
├── index.ts
├── package-lock.json
├── package.json
├── src
│ ├── @types
│ │ ├── express.d.ts
│ │ └── model.d.ts
│ ├── environment.ts
│ ├── lib
│ │ └── auth
│ │ ├── adapters
│ │ │ ├── basic-jwt.ts
│ │ │ └── google-oauth.ts
│ │ ├── auth-adapter.ts
│ │ └── auth-worker.ts
│ ├── middlewares
│ │ ├── auth-protected.ts
│ │ └── log.ts
│ ├── models
│ │ ├── conversation.ts
│ │ ├── deletedUser.ts
│ │ ├── follow-relationship.ts
│ │ ├── like-interaction.ts
│ │ ├── location.ts
│ │ ├── media.ts
│ │ ├── message.ts
│ │ ├── planet.ts
│ │ ├── post.ts
│ │ ├── question.ts
│ │ ├── token.ts
│ │ └── user.ts
│ ├── routes
│ │ ├── faqs
│ │ │ └── index.ts
│ │ ├── feed
│ │ │ ├── [planetOrUserId].ts
│ │ │ └── index.ts
│ │ ├── index.ts
│ │ ├── planet
│ │ │ ├── [nameOrId].ts
│ │ │ └── index.ts
│ │ ├── post
│ │ │ ├── [id]
│ │ │ │ ├── comment.ts
│ │ │ │ ├── index.ts
│ │ │ │ ├── like.ts
│ │ │ │ └── save.ts
│ │ │ ├── index.ts
│ │ │ └── search
│ │ │ └── [search].ts
│ │ └── user
│ │ ├── [id].ts
│ │ ├── [id]
│ │ │ └── follow.ts
│ │ ├── changeBio.ts
│ │ ├── changeEmail.ts
│ │ ├── changeUsername.ts
│ │ ├── changeavatar.ts
│ │ ├── changepassword.ts
│ │ ├── chat.ts
│ │ ├── commented.ts
│ │ ├── conversations.ts
│ │ ├── deleteaccount
│ │ │ └── delete.ts
│ │ ├── follower.ts
│ │ ├── following.ts
│ │ ├── forgetpassword.ts
│ │ ├── getchats.ts
│ │ ├── index.ts
│ │ ├── liked.ts
│ │ ├── login.ts
│ │ ├── oauth
│ │ │ └── google.ts
│ │ ├── resetpassword
│ │ │ └── [token].ts
│ │ ├── saved.ts
│ │ ├── search
│ │ │ └── [search].ts
│ │ └── signup.ts
│ └── utils
│ ├── bcrypt.ts
│ ├── email.ts
│ ├── express.ts
│ ├── image.ts
│ ├── jwt.ts
│ └── regex.ts
└── tsconfig.json