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:

VITE_SOCKET_URL=

Backend:

PORT=
VERSION=

DB_HOST=
DB_PORT=
DB_DATABASE=

ORIGIN=

Installation

1. Clone this repository:

   git clone https://github.com/migliorelli/fartic
   cd fartic

2. Install dependencies:

   yarn install #first install concurrently
   yarn install:all #then install all the packages in both directories

3. Run the development server:

   yarn dev

4. Open your browser at 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:

   git checkout -b feature/new-feature

3. Make your changes and commit them:

   git commit -m "Add new feature"

4. Push your changes:

   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.

License

This project is licensed under the MIT License.

Contact

• Author: Migliorelli
• Email: [email protected]