https://github.com/migliorelli/fartic
Fartic is a drawing game, just like Gartic.
https://github.com/migliorelli/fartic
canvas canvas-api canvas2d drawing drawing-game express gartic socket-io tailwindcss vue
Last synced: 2 months ago
JSON representation
Fartic is a drawing game, just like Gartic.
- Host: GitHub
- URL: https://github.com/migliorelli/fartic
- Owner: migliorelli
- Created: 2025-02-12T19:21:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-24T21:11:01.000Z (over 1 year ago)
- Last Synced: 2025-06-28T15:42:53.433Z (12 months ago)
- Topics: canvas, canvas-api, canvas2d, drawing, drawing-game, express, gartic, socket-io, tailwindcss, vue
- Language: TypeScript
- Homepage:
- Size: 488 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fartic
Fartic is a drawing game, just like Gartic.
## Access
> Working on it
## Features
Frontend:
- Vue
- Vue Router
- Pinia
- SocketIO
- Lucide Icons
- Axios
Backend:
- MongoDB
- SocketIO
- Express
- MVCS design pattern
## Environment variables
Frontend:
```env
VITE_SOCKET_URL=
```
Backend:
```env
PORT=
VERSION=
DB_HOST=
DB_PORT=
DB_DATABASE=
ORIGIN=
```
## Installation
1. Clone this repository:
```bash
git clone https://github.com/migliorelli/fartic
cd fartic
```
2. Install dependencies:
```bash
yarn install #first install concurrently
yarn install:all #then install all the packages in both directories
```
3. Run the development server:
```bash
yarn dev
```
4. Open your browser at [http://localhost:5173](http://localhost:5173) to view the app.
## Building for Production
>TBH I don't know how I'll do it.
## Contributing
1. Fork the project.
2. Create a new branch:
```bash
git checkout -b feature/new-feature
```
3. Make your changes and commit them:
```bash
git commit -m "Add new feature"
```
4. Push your changes:
```bash
git push origin feature/new-feature
```
5. Open a Pull Request.
## Dependencies
This project uses the following dependencies:
- **Vue 3**: A progressive JavaScript framework.
- **TypeScript**: For type-safe development.
- **Vite**: A next-generation frontend tooling.
- **Lucide**: Icon library.
- **Axios**: For API requests.
- **Express**: For the backend.
- **SocketIO**: For realtime features.
- **MongoDB**: As database.
For a complete list of dependencies, see the `package.json` file of each directory.
## Icon
The project uses Lucide icons. Check out the library at [Lucide Vue Next](https://github.com/lucide-icons/lucide).
## License
This project is licensed under the [MIT License](LICENSE).
## Contact
- Author: **Migliorelli**
- Email: [miglenten@gmail.com](mailto:miglenten@gmail.com)