chrissiku / qrcode-generator

📗 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

📖 QR-code generator

QR codes, short for Quick Response codes, have become a ubiquitous sight in the modern world. They can be found on everything from product packaging to business cards, and they are an essential tool for transferring information from one device to another.

🛠 Built With

Tech Stack

Client

• Rails

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• QR-code generator
• Active_storage installation

(back to top)

🚀 Live Demo

• Not available

(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:

Setup

Clone this repository to your desired folder:

    mkdir my-folder  
    cd my-folder 
    git clone [email protected]:Chrissiku/qrcode-generator.git
    cd qrcode-generator

Install

Install this project with and all dependencies:

  bundle install

Usage

To get started with this project, follow the steps bellow :

1. On the root, create a file called .env
2. inside the file all the following :

DB_USERNAME = your_database_username
DB_PASSWORD = your_database_password

3. Then setup the database In your terminal run the command bellow

rails db:setup
or
rails db:create

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rails spec

Local Deployment

http://localhost:3000

(back to top)

👥 Author

👤 Name	Github	Twitter	LinkedIn
Christian Siku	@Chrissiku	@christian_siku	LinkedIn

(back to top)

🔭 Future Features

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse Inc for the readme template used in this project

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)