leehaney254/sales-agent

This is a dashboard for Zerakis sales agent.

📗 Table of Contents

• 📗 Table of Contents
• 📖 Sales Agent Dashboard
  • 🛠 Built With
    • Tech Stack
    • Back-end
  • 🚀 Live Demo .
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Sales Agent Dashboard

Sales-agent-app is a user-friendly and responsive tool designed to help manage schools effectively. With its intuitive interface and a range of features, this app simplifies tasks like invoicing and collections. I've kept the design simple and easy to use, with colors inspired by Zeraki for a seamless integration with existing products.

🛠 Built With

Tech Stack

This project was build using Angular, Typescript and json server.

Client

• Angular
• Typescript
• Ngx-charts
• Angular Material

Server

• Json-server

(back to top)

ERD Diagram

The apps ERD diagram of how the json server should function can be found here.

(back to top)

🚀 Live Demo .

• The project is not yet hosted.

  • To login as you can use any email and password. The logic has not been implemented.

  (back to top)

Key Features

Features in this project

• Login
• Dashboard
• Schools

(back to top)

Prerequisites

In order to run this project you need:

• A code editor
• A browser
• Install Nodejs
• Instal angular CLI

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

• Create a local directory where you can clone the project
• Clone the project to your directory by running

git clone https://github.com/leehaney254/sales-agent.git

• Checkout to develop branch by running

git checkout develop

• Run

npm install

• Run the command below to make sure json server is running

npm run json-server

• Run the command below to start the app

 ng serve --open

(back to top)

Usage

To run the project, execute the following command:

  ng serve --open

To run the tests, execute the following command:

  ng test

NB: To run the tests successfully make sure you have connected the front-end to json-server.

(back to top)

👥 Author

👤 Leehaney George

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Test Writing of more unit test to improve coverage and stability.
• CRUD implementation of crud functionality to improve the applications functionality.
• Authentication and Authorization implementaion of security features.
• Improve UI add more frontend features and make it more aesthetic.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project kindly leave a ⭐ and reach me through our social media links above.

(back to top)

🙏 Acknowledgments

This app was developed as a take-home assignment by Leehaney George for Zeraki.

(back to top)

📝 License

This project is MIT licensed.

(back to top)