This repository is meant for VenturPlex projects as a starting point when creating applications. Anyone within the VenturPlex organization is welcome to use this for faster initial development and/or prototyping. You may start with updating this README and editing the appropriate portions.
Before you begin you need to make sure you have everything needed to get the project up and running.
- Make sure you are on the latest node
- We are using yarn as the package manager for the frontend application.
- Depending on your role on this project, reach out for specific permissions.
- It will be best if you are on a MacOS machine, otherwise, there may be extra configurations needed on your end.
Once all prerequisites are complete, run make init to download other necessary tools for development on MacOS.
We may be using Terraform for our infratstructure tooling with AWS. If the AWS CLI has never been installed on your machine before, make sure to configure it.
For local development, run the following make commands:
# Run this first and only once to install client dependencies.
- make install
# Starting the client application
- make start-client # This will start the client application
# Starting the server
- make start-server # starts up hasura and automatically applies migrations
# Opening the Hasura Console (optional)
- cd server
- hasura console
# This step is only required if you need access to the database. You can also find the GQL playground here, which may be helpful during development.
# Run this to start clean versions of the applications
- make start-cleanNote: Check back frequently in case anything has changed.
The frontend is available on http://localhost:4200 The backend is available on http://localhost:9695
👤 VenturPlex