Welcome to the Stock Market Simulation App! This app is designed to allow users to simulate buying and selling stocks, add them to their watchlist, view stock details, and share their profiles with others.
The project is structured into two important folders: app
and api
.
The app
folder contains the Android app, which was made using Kotlin.
The api
folder contains a Hono Cloudflare Workers Edge API, which uses PlanetScale as a serverless
database. The API was created using TypeScript.
To run the backend (the API), follow these steps:
Choose a node package manager of your choice, for example pnpm
.
- Navigate to the
api
folder in your terminal. - Copy the .dev.vars file.example to .dev.vars and fill in the required values.
- Install dependencies using your preferred package manager:
pnpm install
- Generate the prisma edge client:
pnpm prisma generate --data-proxy
- Push the db schema to PlanetScale:
pnpm prisma db push
- Start the API:
pnpm dev
To run the frontend (the Android app), follow these steps:
- Open the project in Android Studio.
- Open the strings.xml file in the
app/src/main/res/values
folder. - Edit the
default_web_client_id
to match your backend's google web id. - Change the base url to match your backend's url.
- Run the app.
- Enjoy!
This project is licensed under the MIT License. See the LICENSE file for more information.
Created by Arthur De Witte for the Native Mobile Apps course (part of the Applied Computer Science study) at Howest University.