"If offered a seat on a rocket ship, don't ask what seat. Just get on." — Christa McAuliffe
Welcome to Exo, your gateway to seamless interplanetary travel in the year 2160. Embark on a journey through the Solar System, explore distant planets, and experience the universe like never before. Exo is your invitation to embark on a voyage of discovery and adventure.
Exo follows a "monorepo" structure to keep both frontend and backend code organized as intuitively as possible. The project is divided into two main folders: exo-frontend and exo-backend.
To set up and run Exo locally, follow these steps:
Clone Exo to a desired location on your machine by opening up a terminal from the folder and entering the following command:
git clone https://github.com/Caramel-Labs/exo.gitIn the terminal opened up in the cloned folder, move into the exo-frontend folder:
cd exo-frontendInstall the necessary dependencies:
npm installStart the frontend NextJS server:
npm run devWe recommend setting up a remote MongoDB instance (Atlas server) for this.
Use the mongorestore utility to load the database into your remote MongoDB instance.
Next, create a .env file inside the exo-backend folder and include the MongoDB connection string to your MongoDB cluster in it. It should look something like this:
MONGO_URI = mongodb+srv://admin:[email protected]/
Open up a new terminal from the root folder of the project, and move into the exo-backend folder:
cd exo-backendInstall the necessary dependencies:
npm installStart the frontend ExpressJS server:
node index.jsAfter both the frontend and backend servers have been started, visit http://localhost:3000 from your browser.
Separate information about the various architectures, technologies and design decisions for the frontend and backend can be found in their respective folders.
Exo was brought to life by a team of visionary developers and designers: