Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erikyo/tauri-app-starter
Tauri Todo App is a boilerplate for building feature-rich full-stack application
https://github.com/erikyo/tauri-app-starter
Last synced: about 2 months ago
JSON representation
Tauri Todo App is a boilerplate for building feature-rich full-stack application
- Host: GitHub
- URL: https://github.com/erikyo/tauri-app-starter
- Owner: erikyo
- Created: 2024-02-23T16:57:06.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-03-03T23:24:04.000Z (10 months ago)
- Last Synced: 2024-10-10T00:42:26.832Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.27 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# App
The Tauri Todo App is a full-stack application designed as a starting point for building feature-rich, containerized applications.
### RestAPI Server
The API server is built using Fastify, a high-performance web framework for Node.js. The server is configured with HTTPS, logging, authentication via Supertokens, and Swagger documentation.
### Frontend App
A simple Todo application built with React, React Router, and Tauri APIs. The frontend integrates Supertokens for secure authentication.
### Features
**Dockerized Environment**: Utilizes Docker Compose to orchestrate services such as MySQL, Supertokens, and Fastify API for seamless development.
**Frontend (React) App**: A simple Todo application built with React, React Router, Tailwind, and Tauri APIs. The frontend integrates Supertokens for secure authentication.
**Fastify REST API**: Employs Fastify, a high-performance web framework, for the backend API. The API supports CRUD operations for managing tasks.
**Supertokens Authentication**: Enhances security with Supertokens, providing a robust authentication mechanism for user sessions.
**Tauri Integration**: Utilizes Tauri, a framework for building native-like applications, to package and distribute the app across different platforms.
### Docker-compose will bring up a full-stack application with the following services:
- db-supertokens: MySQL database for Supertokens. (port 3307)
- supertokens: Supertokens service. (port 3456)
- db-app: MySQL database for the application. (port 3306)
- adminer: Adminer for MySQL database management (port 3002)
- api: Dockerized Fastify API server (port 3001)
- app: Node.js image for building and running the frontend app (port 3000)
# Requirements
**Docker**
Download the latest version of Docker Desktop from [here](https://www.docker.com/products/docker-desktop)
**Node.js**
Download the latest version of Node.js from [here](https://nodejs.org/en/download/)
## How to use
#### Run the app
starts the app in development mode
```bash
npm run start
```
#### Run the tests
Will run the test suite
```bash
npm run tests
```
#### Re-build
Normally isn't required, you nee it to rebuild containers after a docker configuration change
```bash
npm run force-reload
```
#### Down
Shut down the current docker container
```bash
npm run down
```
## Publishing the app
In order to release the app you need to copy the env file and name it `.env.production`. Then edit that file using the production ip, ports, secrets and run
```bash
npm run build-app
```
That's it!🎉 Tauri will build the Windows/Linux/MacOs app following the configuration located in [tauri.conf.json](https://github.com/erikyo/tauri-app-starter/blob/master/app/src-tauri/tauri.conf.json)
## Contributions
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.