Skip to content

ada-pld/ada-ui

Repository files navigation

ADA UI

Status GitHub issues GitHub Pull Requests


User Interface of the Ada original API created by Théo Hemmer

⭐️

If you like this project, do not hesitate to contribute and star it

📝 Table of Contents

🧐 About

For our end-of-school project at Epitech Nancy, we are required to regularly submit project log documents detailing our work through diagrams and user stories. We must also organize our team's work to move in a single direction.

Ada aims to simplify this process through the creation of user stories, changing their status (not started/in progress/completed), as well as scheduling appointments and automatically generating PLDs. Many features will be regularly added to Ada to evolve and become a project tracking tool for EIP projects.

The development of this tool was initiated by Théo hemmer, and the creation of ada_ui was a natural next step.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

First, you need to have a Ada instance running and operational. Please check the Ada documentation to install your environment

Installing

First thing first, you need to clone ada_ui project

git clone git@github.com:protoxvga/ada_ui.git

Install ada_ui dependencies

npm install

If you want to contribute and develop on ada UI you need a .env file Create a .env file at the root of the repository with the following values

BASE_URL=YOUR_BASE_URL

ex.

BASE_URL=https://myserver.fr

Finally if you want to run the application:

npm run dev

And your application shoul run on http://localhost:3000

To build ada in static for deployment:

npm run build

👨🏻‍💻 Contribute

You can follow the contribution guidelines here

⛏️ Built Using

✍️ Authors

See also the list of contributors who participated in this project.