From b18da3ca7fdef54a041b60ef05a264e10e319e7a Mon Sep 17 00:00:00 2001 From: Hazem Krimi Date: Sun, 11 Jun 2023 18:19:02 +0100 Subject: [PATCH] Update README.md --- README.md | 61 ++++++++++++++++++++++++------------------------------- 1 file changed, 27 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 6983c95..8676086 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,30 @@ -# Table of Contents - -1. [Introduction](#Introduction) -2. [Features](#Features) -3. [Credits](#Credits) - -# Introduction -This was my final year of studies projects where my collegue and I worked on a prototype for a project building solution for the agency we had an internship in called [Astrolab](https://astrolab-agency.com). -As there were lockdowns in Tunisia in 2020/2021 because of covid software agencies and clients could not have in person meetings to discuss a client's software project. -So the idea of Astrobuild is to reduce meetings and make the client participate with other stakeholders in the process of creating a software project by tracking and communicating with their associated product owner. - -# Features +# Access Accounts for The Demo 1. Client - - Account management - - Project creation from choosing the templates, features and deliverables (Specification, design, MVP or full build) - - Project tracking - - Chat with associated product owner for tracking and support - - Payment (WIP) -2. Product Owner - - Account management - - Management of templates - - Review of projects and transferring deliverables - - Chat with clients on their projects -3. Developer - - Account management - - Features, categories and wireframes management -4. Admin - - Identity and access management (WIP) +``` +- Email: client@client.cc +- Password: 123456 +``` +3. Product Owner +``` +- Email: po@po.cc +- Password: 123456 +``` +5. Developer +``` +- Email: dev@dev.cc +- Password: 123456 +``` +7. Admin +``` +- Email: admin@admin.cc +- Password: 123456 +``` -# Technologies Used -The frontend project is a [React](https://react.dev) application with [TypeScript](https://www.typescriptlang.org) which consumes a set of [GraphQL](https://graphql.org) APIs using [Apollo GraphQL](https://www.apollographql.com) and a some REST APIs. -A small components library with a custom theme was made for this project using [Styled Components](https://styled-components.com) which can be viewed at the `components` folder. -The prototyping feature was done using [React Flow](https://reactflow.dev) which is a library for creating and interacting with diagrams. -To view the full architecture of the application go [here](https://github.com/MedAmineFouzai/astrobuild-api/blob/main/README.md). +# Installation +Check the `.env.example` for the list of APIs to use then clone and run -# Credits -- Mohamed Amine Fouzai: [GitHub](https://github.com/MedAmineFouzai), [LinkedIn](https://www.linkedin.com/in/amine-fouzai) +``` +yarn +``` + +For the backend configuration check [here](https://github.com/MedAmineFouzai/astrobuild-api)