SummerIQ is a project aimed at providing intelligent analysis and insights.
The project consists of two main parts:
- Frontend: Built with React, TypeScript, Vite, shadcn-ui, and Tailwind CSS.
- Backend: A Rust application using axum, sqlx, and PostgreSQL for data storage.
To set up and run SummerIQ locally, you need to have the following installed:
- Node.js & npm (or bun)
- Rust and Cargo
- PostgreSQL
- sqlx-cli
-
Install Rust and Cargo: Follow the instructions on the official Rust website.
-
Install sqlx-cli:
cargo install sqlx-cli --no-default-features --features native-tls,postgres -
Set up PostgreSQL: Ensure you have a PostgreSQL server running and a database created for SummerIQ. Make note of the database connection URL.
-
Set Environment Variables: Create a
.envfile in thesummeriq-backenddirectory with your database connection URL. For example:DATABASE_URL=postgres://user:password@host:port/database_name
-
Run Migrations: Navigate to the
summeriq-backenddirectory and run the migrations.cd summeriq-backend sqlx migrate run -
Run the Backend: Stay in the
summeriq-backenddirectory and run the backend server.cargo run
-
Navigate to the frontend directory:
cd ..(if you are insummeriq-backend) or ensure you are in the project root. -
Install dependencies:
npm install(orbun install) -
Run the Frontend: Start the development server.
npm run dev
The frontend should be available at
http://localhost:8080/or a similar port.
...
Frontend:
- React
- TypeScript
- Vite
- shadcn-ui
- Tailwind CSS
Backend:
- Rust
- axum
- sqlx
- PostgreSQL