MuhammeedAlaa / MeanStack-Fish

A fish application used to handle orders in angular 9

Fish-MEANStack

An application for a fish shop delivery.

Tools used

• Server: NodeJs with Express as framework.
• frontend: Angular
• database: mongoDB.
• Function documentation: jsdoc.
• API documentation: postman
• Code Style: airbnb

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Back-end

• you need to clone the project, then open a terminal in the root directory and write the following command:

  npm i
  

• then you will need a file called .env without a name only an extension to exist in the root directory the file example.env has the kind of variables you need to have.

• for running the project you can npm i -g nodemon then type nodemon it will run the project and refresh at any change of code on saving.

Front-end

• This project was generated with Angular CLI version 9.1.9.

• building: navigate to ./angular then Run ng build to build the project. The build artifacts will be stored in the ./public directory. Use the --prod flag for a production build.

API documentation

• postman documentation was used for this project, you can find the post man collection in the root of the repo in json format you can import it in postman application.

Author

• Muhammad Alaa Abd El Khaliq

License

• Licensed under the MIT License.

External links

you can find a heroku deployed version of the project in the following link.