Skip to content

Latest commit

 

History

History
107 lines (70 loc) · 3.3 KB

README.md

File metadata and controls

107 lines (70 loc) · 3.3 KB
Raw

DARS

DARS Logo

DARS is a comprehensive order screen application designed specifically for restaurants. It provides a user-friendly interface for managing orders efficiently and effectively. This repository contains the source code for both the frontend and backend of the application, which are built using Next.js, Tailwind CSS, SQLite, and Go. The project also includes Docker support for easy containerization.

🚀 Features

  • Order management: DARS enables restaurant staff to manage incoming orders effectively, facilitating a streamlined workflow.
  • User-friendly interface: The application offers an intuitive and easy-to-use interface, ensuring a smooth user experience for restaurant staff.
  • Next.js and Tailwind CSS: The frontend is built using Next.js, a popular React framework, and styled with Tailwind CSS, providing a responsive and visually appealing design.
  • SQLite and Go: The backend of DARS utilizes SQLite as the database management system and Go as the programming language, ensuring a robust and efficient server-side implementation.
  • Docker support: The project supports Docker, allowing for easy deployment and containerization of the application.

⚙️ Configuration

you need to configure a few settings:

  1. Create a .env file in the app directory, cp .env.example .env and specify the following environment variables:

    NEXT_PUBLIC_API_URL=http://localhost:8080/api
NEXT_PUBLIC_API_TOKEN=<random_api_token>

  2. Create a .env file in the api directory, cp .env.example.env and specify the following environment variables:

    API_TOKEN=<random_api_token>

🛠️ Installation

To set up DARS locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/anggakharisma/spice-republic.git

  2. Navigate to the project directory:

    cd spice-republic

  3. Install the dependencies for the app:

    cd app
{pnpm, yarn, npm} install

  4. Install the dependencies for the backend:

    cd api
go mod download

🚀 Usage

To start the DARS application, follow these steps:

  1. In the app directory, run the following command:

    {npm, yarn, pnpm} run dev

    This will start the development server for the app.

  2. In the api directory, run the following command:

    cd api
go run main.go

    This will start the api server. Check api README.md for more information, like docker usage

  3. Open your browser and visit http://localhost:3000 to access DARS.

👥 Contributing

Contributions to DARS are welcome! If you find any issues or have suggestions for improvement, please feel free to open an issue or submit a pull request.

📄 License

This project is licensed under the MIT License.

👏 Acknowledgments

We would like to acknowledge the following open-source projects and libraries that were used in the development of

DARS: