📗 Table of Contents

• 📗 Table of Contents
• 📖 LMW Webpage
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Setup
    • Prerequisites
    • Usage
  • 👥 Authors
  • 🤝 Contributing
  • Future Features
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 BACKEND API - OILCHEM MUD SCHOOL CERTIFICATE PORTAL

The BAKEND API - OILCHEM MUD SCHOOL CERTIFICATE PORTAL project is a Ruby on Rails API-only application. It manages the CRUD backend logic and Postgresql database of the application. It is connected to two Reactjs frontend apps: the CMS and verifier apps.

This project aims to provide an effective solution to enable the Oilchem Mud School students and potential employers to digitally verify certificates of job applicants from Oilchem Mud School 📚

This project comprises of -

• Rails Backend API only App - manages PostgreSQL database and CRUD methods
• React CMS - provides user interfaces to admins for effective content management
• React Certificate Verification Portal - provides an interface for students to check the availability of and download their certificates. Also providing employees an interface to authenticate and verify certificate IDs. This application is connected to the backend application and converts the details to a graphically designed and downloadable certificate.

🚀 Live Demo

• Admin/CMS Demo Link
• User/portal Demo Link
• Api Docs Demo Link
• Video Presentation

🛠 Built With

• React
• Redux
• CSS

Key Features

• React-Based User Interface
• Modular Structure
• Create, read, update, and delete features for certificates, students, personnel, and batch
• Navigation

Kanban Board:

Kanban-board

Team:

This is a solo project

(back to top)

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• A basic understanding of React, Redux and Git

Usage

1. Clone this repo
2. Run npm install

git clone https://github.com/geekelo/oilchem-certificate_portal_user.git

To run the project, execute the following command:

  npm start

(back to top)

👥 Authors

👤 Eloghene Otiede

• GitHub: @geekelo
• LinkedIn: eloghene-otiede
• Website: portfolio

(back to top)

🔭 Future Features

• Edit Admin Profile
• Super Admin management

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Please support this project and be a part of something meaningful and impactful. Your contribution can make a significant difference and help us achieve our goals faster.

(back to top)

🙏 Acknowledgments

I would like to express my sincere gratitude to Eloti Designs for trsting my competence in executing this project for their client OILCHEM MUD SCHOOL

(back to top)

❓ FAQ

• Can I fork and reuse this repository?

Absolutely! Please feel free to fork and reuse this repository for your own projects.

• Is it okay to improve this repository? Will my changes be accepted?

Definitely! We welcome any improvements or new ideas you may have. If your changes are good and align with the project's goals, we would be happy to accept them.

(back to top)

📝 License

This project is MIT licensed.

(back to top)