📗 Table of Contents
📖 PSS DIGITAL BACKEND
Pss-Digital is a proven digital solution that makes online shopping easy, convenient, and enjoyable for customers. The application also helps other businesses maximize their customer base through e-commerce. With PSS Digital, we help you achieve success while also supporting you in efficient business management.
Erd diagram
🛠 Built with
Tech stack
Client
Server
Database
Key features
Key features of the application are
- Fetch all orders
- Fetch all products
- Authenticate users
- Add product
- Delete product
- Place orders
- Delete orders
🗎 API documentation
Kanban Board
-
At the beginning we were a team of five (after our studies at Microverse) we used Kanban board to manage our project tasks
-
Check here Kanban Board Kanban Board
-
Here is the link to kanban board initial state
PSS-Digital-Frontend
🚀 Live demo
💻 Getting started
This project can be used by anyone for any good purpose.
To get a local copy up and running, follow these steps.
Pre requisites
In order to run this project you need:
- Ruby and Rails on you operating system eg. for Windows or Linux
- React.js
- Install nodejs
- PostgreSQL database installed
- Install Git
- Install a code editor of your choice
- Knwoledge of javascript and react
- Github account is required
Setup
Clone this repository to your desired folder:
git clone https://github.com/Olivier-Kango/pss-digital-backend.git
Install
Install this project with:
cd pss-digital-backend # Change directory into project folder
bundle install # Installs project dependencies
Important steps after installing project to local machine
- Please run rails db:create and rails db:migrate.
- Check Ruby version and database.yml file. ( Insert your password if there is required)
Usage
To run the project, execute the following command:
rails s # for running the project in development mode
Run tests
To run tests, run the following command:
rubocop -A # for checking and correcting linter errors
rake rswag # for checking the API documentation
Note: If for some reason you are not able to run the tests, please delete the folowing files:
config/credentials.yml.enc
config/master.key
and run the following commands:
EDITOR="code --wait" bin/rails credentials:edit
and then run the tests again
Deployment
You can deploy this project using:
👥 Authors
👤 Dave Zagabe From DRC - Bukavu
👤 Olivier Kango from DRC - Goma
🔭 Future Features
- Implement Mobile Version
- Add the ability to upload an Image
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
If you like this project buy us a drink
🙏 Acknowledgments
I would like to acknowledge:
- Microverse for the opportunity to work on this project
- The creative common for the design
- Design from Murat Korkmaz on Behance
❓ FAQ
-
Is Rails still relevant?
-
Is it easy to learn Ruby on Rails
📝 License
This project is MIT licensed.