BoardroomManager WEB

Manage boardrooms with this Angular application 🚀

📌 Table of Contents

• Features
• Requirements
• Installation
• Getting Started
• Build
• FAQ
• Found a bug? Missing a specific feature?
• Contributing
• License

🚀 Features

• CREATE a Boardroom
• GET Boardroom details
• GET Boardroom list
• UPDATE a Boardroom details
• DELETE a Boardroom

It's important to mention that this is one of the applications from the BoardroomManager System

In order to explore the others, feel free to click on the link below:

• BoardroomManager API

Requirements

For building and running the application you need:

• Node and npm
• Angular CLI

👷 Installation

To install this application, run the following commands:

git clone https://github.com/iamgrodrigues/boardroommanager-web.git

If you have a SSH key registered in your Github account, clone the project using this command:

git clone [email protected]:iamgrodrigues/boardroommanager-web.git

Installing npm packages

To install npm packages described in the package.json run this command:

npm start

🏃 Getting Started

Running the application locally

Run the following command:

ng serve

After the above command, you can navigate to the following address to see the project up and runnig:

http://localhost:4200/

Note: The app will automatically reload if you change any of the source files.

Setting up the API

The interface needs to interact with the server to get all the data related to the boardroons.

Make sure to go to the BoardroomManager API repository and follow the instructions in order to get it running on your machine.

🛠️ Build

In order to build this application run the following command:

ng build

The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

📮 Faq

Question: What are the tecnologies used in this project?

Answer: The tecnologies used in this project are Typescript + Angular + Html + Css.

🐛 Issues

Feel free to file a new issue with a respective title and description on the the boardroommanager API repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.

🎉 Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

📕 License

Released in 2021. This project is under the MIT license.

Made with love by Guilherme Rodrigues 💚🚀