MSaeed1381 / IE_HW2

Internet Engineering Home Work 2

Golestan Rest Api

Golestan Rest CRUD API
Explore the docs »

View Demo - Report Bug - Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

In this project I implement a rest api for golestan project

(back to top)

Built With

• javascript
• node.js
• MVC structure

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• docker

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

or download and install for other operation syatem.

    https://docs.docker.com/desktop/install/

Installation

1. Clone the repo

   git clone https://github.com/MSaeed1381/IE_HW2.git

2. Install NPM packages

   npm install

3. run the project

  npm run dev

or you can run with docker compose file.

    docker compose up -d

(back to top)

Usage

• I create front-end in this project. (golestan front end)
• you can use this api for your university :).

Roadmap

• Responsive
• add hover
• dynamic website
• Multi-Language Support
  • English
  • Persion
  • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT license. See LICENSE.txt for more information. (MIT LICENSE)

Contact

Saeed Zare - instagram - [e-mail]

Project Link: https://github.com/MSaeed1381/IE_HW2

Acknowledgments

• w3schools
• Mozilla

(back to top)