https://github.com/ananta/flashswipe
A Flashcard app built using React Native on the frontend & Rust on the backend. This app was built as a coursework for the class "Software Development Methodology"
https://github.com/ananta/flashswipe
actix-web react-native react-query rust sqlx tamagui typescript zustand
Last synced: 3 months ago
JSON representation
A Flashcard app built using React Native on the frontend & Rust on the backend. This app was built as a coursework for the class "Software Development Methodology"
- Host: GitHub
- URL: https://github.com/ananta/flashswipe
- Owner: ananta
- Created: 2023-01-31T16:06:54.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-19T16:11:14.000Z (over 1 year ago)
- Last Synced: 2025-04-06T03:58:20.527Z (6 months ago)
- Topics: actix-web, react-native, react-query, rust, sqlx, tamagui, typescript, zustand
- Language: TypeScript
- Homepage:
- Size: 8.79 MB
- Stars: 20
- Watchers: 2
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FlashSwipe
## Background
FlashSwipe is a full-stack mobile app built on top of [React Native](https://reactnative.dev/) + [Rust](https://www.rust-lang.org/)
## Requirements
Make sure you have the following program installed on your dev system
- [Node.js](https://nodejs.org/en)
- [Brew](https://brew.sh/)
- [Make](https://formulae.brew.sh/formula/make)
- [Rust](https://doc.rust-lang.org/book/ch01-01-installation.html)
- [Docker](https://docs.docker.com/get-docker/)
## Database Setup
We will be using docker containers to setup our PostgreSQL database.
You can use the command `make init_db` that will automatically:
- create a container named `flashswipe_db_container`
- setup a postgres server inside the container &
- expose it to the default postgres port `5432`
## Running the Backend
You need to create a `.env` file inside the `/backend/` directory with the keys defined inside the `.env.sample`
After setting up the `.env` file, you can run the application using: `make run` or `cargo run`
## Migrations
If you want to update the database table, please follow the guidelines to add the migration sequence:
`SEQUENCENUMBER_DESCRIPTION.sql` inside the `/migrations` directory