Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shiyinq/fasmo
🚀 My starter project for the FASMO Stack, utilizing FastAPI, Svelte, and MongoDB to build a modern web application.
https://github.com/shiyinq/fasmo
fastapi mongodb public-template python starter-project svelte sveltekit typescript
Last synced: about 12 hours ago
JSON representation
🚀 My starter project for the FASMO Stack, utilizing FastAPI, Svelte, and MongoDB to build a modern web application.
- Host: GitHub
- URL: https://github.com/shiyinq/fasmo
- Owner: Shiyinq
- License: unlicense
- Created: 2024-07-08T03:31:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-16T01:28:33.000Z (4 months ago)
- Last Synced: 2024-08-24T02:52:04.820Z (3 months ago)
- Topics: fastapi, mongodb, public-template, python, starter-project, svelte, sveltekit, typescript
- Language: TypeScript
- Homepage:
- Size: 562 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FASMO
('-. .-') _ .-')
( OO ).-. ( OO ).( '.( OO )_
,------./ . --. /(_)---\_),--. ,--.).-'),-----.
('-| _.---'| \-. \ / _ | | `.' |( OO' .-. '
(OO|(_\ .-'-' | |\ :` `. | |/ | | | |
/ | '--.\| |_.' | '..`''.)| |'.'| |\_) | |\| |
\_)| .--' | .-. |.-._) \| | | | \ | | | |
\| |_) | | | |\ /| | | | `' '-' '
`--' `--' `--' `-----' `--' `--' `-----'
FASMO - FastAPI SvelteKit MongoDB
The project structure for the backend is inspired by [this repository](https://github.com/zhanymkanov/fastapi-best-practices?tab=readme-ov-file#project-structure).
The frontend of the project is built using SvelteKit, initialized with the command:
`npm create svelte@latest fasmo`
# Table of Contents
- [FASMO](#fasmo)
- [Table of Contents](#table-of-contents)
- [Development](#development)
- [Backend](#backend)
- [Frontend](#frontend)
- [Formatting](#formatting)
- [Deployment](#deployment)
## Development
### Backend
**1. Create a Virtual Environment (venv)**
Create a virtual environment (venv) using conda with the following command:
```
conda create -n [venv-name] python=3.10
```
Activate the venv with the following command:
```
conda activate [venv-name]
```
**2. Install requirements**
Install the required dependencies with the following command:
```
pip install -r requirements/dev.txt
```
**3. Create the .env File**
Create and update `.env` file based on `.env.example`
```
cp .env.example .env
```
**4. Run the backend**
Run the server with the following command:
```
sh script/start-dev.sh
```
**5. Open the API Documentation**
The API documentation can be opened in a browser at the following address:
```
http://localhost:8000/docs
```
### Frontend
**1. Go to frontend folder**
Go to frontend folder and install dependencies:
```
cd frontend
npm install
```
**2. Create the .env File**
Create and update `.env` file based on `.env.example`
```
cp .env.example .env
```
**3. Run the frontend**
Run development server
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
## Formatting
To make the code cleaner and more structured
Backend:
```
sh scripts/lint-fromat.sh
```
Frontend:
```
npm run lint
npm run format
```
## Deployment
Before you begin, ensure you have [Docker](https://docs.docker.com/engine/install/) installed.
**1. Create environment files**
For the backend:
```bash
cp .env.example .env
```
For the frontend:
```bash
cd frontend
cp .env.example .env
cd ..
```
Open each `.env` file you have created and update the values as needed.
**2. Build and run the Docker containers**
```bash
docker compose up --build -d
```
Wait a few minutes for the setup to complete. You can then access:
- Frontend at http://localhost:5000
- Backend at http://localhost:8000