Store Manager is a web application that helps store owners manage sales and product inventory records. This application is meant for use in a single store.
- Application Features
- UI-gh-pages
- [APIRoutes](#API Routes)
- Prerequisites
- Getting Started
- Running the tests
- Built With
- Contributing to the Project
- Credits
- Admin can register new Store Attendant to the application
- Admin/Store Attendant can login to the application
- Admin can create a product record
- Admin/Store Attendant can get all products in the store.
- Admin/Store Attendant can get details of a single product in the store
- Admin can update records of a single product in the store.
- Store Attendant can post a sale record
- Admin/Sale Creator can get details of a single sale
- Admin can get all sale records
HTTP VERB | ENDPOINT | FUNCTIONALITY | |
---|---|---|---|
POST | api/v1/sales | Create Sale Record | |
GET | api/v1/sales/:saleId | Get A sale record | |
GET | api/v1/sales | Get All sales | |
POST | api/v1/products | Create a product record | |
GET | api/v1/products/:productId | Get a single product in the store | |
GET | api/v1/products | Get all products in the store | |
PUT | api/v1/products/:productId | Update details of a product | |
POST | api/v1/auth/signup | Create a user | |
POST | api/v1/auth/login | Sign in a user |
- Install Nodejs and PostgreSQL locally
Follow the steps below to get the app running locally:
# Clone the repository
>$ git clone https://github.com/danoseun/Store-Manager.git
# Change directory into it
>$ cd Store-Manager
# Install all dependencies
> npm install
# Start the application in development mode
> npm run start
# Open the application in the browser
> https:localhost:4000/
npm run test
FrontEnd
HTML- Markup language CSS- Styling
Backend
Nodejs Express
Contributions are welcome and appreciated. To contribute
- Fork this repository or clone the repository with the command
$ git clone https://github.com/danoseun/Store-Manager.git
- Change directory into the folder with the command
cd Store-Manager
- Create your feature branch and make your contributions to your local copy of the project
- Raise a pull Request against the development branch describing what your feature does and how it can be tested
Oluwaseun Somefun