Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rinminase/fourleaf
Notes, Journal + Gas Monitoring webapp
https://github.com/rinminase/fourleaf
netlify preact tailwindcss typescript vite
Last synced: 14 days ago
JSON representation
Notes, Journal + Gas Monitoring webapp
- Host: GitHub
- URL: https://github.com/rinminase/fourleaf
- Owner: RinMinase
- Created: 2024-01-29T11:46:30.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-13T05:05:58.000Z (3 months ago)
- Last Synced: 2024-10-31T03:22:16.617Z (2 months ago)
- Topics: netlify, preact, tailwindcss, typescript, vite
- Language: TypeScript
- Homepage: https://fourleaf.anidb.moe/
- Size: 828 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🍀 Fourleaf App 🍀
## Introduction
_Add info here_
## Introduction
This project uses Preact (Faster & Leaner React) with Vite and deployed to Netlify
## Getting Started
### Running the project
Installations Required:
- [Node](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/latest.msi)
1. Clone the project and copy the ENV template file to a new ENV file.
```
git clone https://github.com/RinMinase/fourleaf.git
cd fourleaf
cp .env.example .env
```
2. Modify the created ENV file based on your Firebase configuration
3. Install the dependencies then run the project
```
yarn install
yarn start
```
4. Fire up your browser and go to `localhost:3000`
### Building the project
Installations Required:
- [Node](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/latest.msi)
1. Fire up your terminal inside the project folder.
2. Build the project by running:
```
yarn build
```
3. This should generate a `dist/` folder inside the project folder.
## Built with
* 
[Preact](https://preactjs.com/) - Web Framework
* 
[TypeScript](https://www.typescriptlang.org/) - Language syntax
* 
[Vite](https://vitejs.dev/) - Source Code Bundler
* 
[TailwindCSS](https://tailwindcss.com/) - Layouting Framework
* 
[Netlify](https://netlify.com) - Hosting Platform