Skip to content

Frags-AI/web_app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Frags App

A full-stack application for LLM built with a frontend and backend setup.


Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v16 or later) and npm
  • Git

Setup Instructions

  1. Clone the Repository
    Open your terminal and run:

    git clone https://github.com/FragsAI/frags_app.git
    cd frags_app
  2. Install Global Dependencies
    Install the required global packages:

    npm install -g nodemon
    npm install -g concurrently
  3. Install Application Dependencies
    Run the following command to install dependencies for both the frontend and backend:

    npm run install:app
  4. Start the Development Environment
    Launch the application in development mode:

    npm run dev

    This command runs both the frontend and backend concurrently.


Available Scripts

Here are the npm scripts available in this project:

  • npm run dev

    Runs the frontend and backend servers in development mode simultaneously.

  • npm run start

    Starts the application in production mode.

  • npm run install:app

    Installs dependencies for both the frontend and backend.

  • npm run start:server

    Starts the backend server.

  • npm run dev:server

    Runs the backend server in development mode with live reloading.

  • npm run start:client

    Starts the frontend server.


Project Structure

The project consists of three main directories:

  1. /frontend
    Contains the client-side code (React-based).

  2. /backend
    Contains the server-side code.

  3. /automation
    Contains the E2E testing code


Repository Information


Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -m "Add your message").
  4. Push to the branch (git push origin feature/YourFeature).
  5. Open a pull request.

License

This project is licensed under the ISC License.


Support

For help or inquiries, contact the repository owner or raise an issue in the GitHub repository.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7

Languages