Outkarm / oop-school-library

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 OOP school library

[OOP-school-library] is a...

🛠 Built With

Tech Stack

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

• [Add new books]
• [Add students and teachers]

(back to top)

🚀 Live Demo

-COMING SOON

(back to top)

💻 Getting Started

• Create a local directory that you want to clone the repository.

• Open the command prompt in the created directory.

• On the terminal run this command git clone [e-mail]:Outkarm/oop-school-library.git

• Go to the repository folder using command prompt cd OOP-School-Library

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

Prerequisites

In order to run this project you need:

-Any broswer

• familiarity with basic git commands

• install WSL to run Ruby

Setup

Clone this repository to your desired folder:

• Open the command prompt in the created directory.

• On the terminal run this command git clone [e-mail]:Outkarm/oop-school-library.git

• Go to the repository folder using command prompt cd OOP-School-Library

• Install the dev dependencies for linters run npm install.

Install

Install this project with:run in terminal git clone [e-mail]:Outkarm/oop-school-library.git

Usage

To run the project, execute the following command: ruby main.rb

Run tests

To run tests, run the following command:ruby main.rb

Deployment

You can deploy this project using:run ruby main.rb in terminal

(back to top)

👥 Authors

👤 John (Koy OutKarm) Kpordje

• GitHub: @Outkarm
• Twitter: @outkarm
• LinkedIn: John (Koy OutKarm) Kpordje

(back to top)

🔭 Future Features

• [Filter By Name]
• [Filter by Book]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, Drop a Star and follow for more exciting stuff

(back to top)

🙏 Acknowledgments

I would like to thank Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)