Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geekelo/oilchem-certificate_portal_api
A backend API for Oilchem Mud School to serve as a certiicate portal for Alumnis
https://github.com/geekelo/oilchem-certificate_portal_api
devise-token-auth postgresql-database rails-api-backend
Last synced: 3 days ago
JSON representation
A backend API for Oilchem Mud School to serve as a certiicate portal for Alumnis
- Host: GitHub
- URL: https://github.com/geekelo/oilchem-certificate_portal_api
- Owner: geekelo
- License: mit
- Created: 2023-12-15T23:29:13.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-01-11T02:30:32.000Z (12 months ago)
- Last Synced: 2024-11-01T13:03:25.612Z (about 2 months ago)
- Topics: devise-token-auth, postgresql-database, rails-api-backend
- Language: Ruby
- Homepage:
- Size: 122 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 LMW Webpage ](#-lmw-webpage-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Setup ](#setup-)
- [Prerequisites ](#prerequisites-)
- [Usage ](#usage-)
- [👥 Authors ](#-authors-)
- [🤝 Contributing ](#-contributing-)
- [Future Features ](#future-features-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-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](https://github.com/geekelo/oilchem-certificate_portal_api) - manages PostgreSQL database and CRUD methods
- [React CMS](https://github.com/geekelo/oilchem-certificate_portal_admin) - provides user interfaces to admins for effective content management
- [React Certificate Verification Portal](https://github.com/geekelo/oilchem-certificate_portal_user) - 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](https://oilchem-certificate-portal-admin.geekelo.com.ng)
- [User/portal Demo Link](https://oilchem-certificate-portal-user.geekelo.com.ng)
- [Api Docs Demo Link](https://oilchem-api.onrender.com/api-docs)
- [Video Presentation](https://youtu.be/4pFrIFyQq98)
- React
- Redux
- CSS
- [x] **React-Based User Interface**
- [x] **Modular Structure**
- [x] **Create, read, update, and delete features for certificates, students, personnel, and batch**
- [x] **Navigation**
## Kanban Board:
[Kanban-board](https://github.com/users/geekelo/projects/4)
## Team:
This is a solo project
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
```
👤 **Eloghene Otiede**
- GitHub: [@geekelo](https://github.com/geekelo)
- LinkedIn: [eloghene-otiede](https://www.linkedin.com/in/eloghene-otiede-b146a3232/)
- Website: [portfolio](https://geekelo.com.ng/)
- [ ] **Edit Admin Profile**
- [ ] **Super Admin management**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
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.
I would like to express my sincere gratitude to [Eloti Designs](https://elotidesigns.com) for trsting my competence in executing this project for their client OILCHEM MUD SCHOOL
- **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.
This project is [MIT](./LICENCE) licensed.