https://github.com/chrissiku/qrcode-generator
https://github.com/chrissiku/qrcode-generator
active-storage rqrcode ruby-on-rails
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/chrissiku/qrcode-generator
- Owner: Chrissiku
- Created: 2023-03-01T21:21:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T21:46:30.000Z (over 3 years ago)
- Last Synced: 2025-04-02T07:41:30.824Z (about 1 year ago)
- Topics: active-storage, rqrcode, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 30.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
> 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
Server
Database
> Describe between 1-3 key features of the application.
- QR-code generator
- Active_storage installation
- [Not available](https://yourdeployedapplicationlink.com)
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:
```sh
mkdir my-folder
cd my-folder
git clone git@github.com:Chrissiku/qrcode-generator.git
cd qrcode-generator
```
### Install
Install this project with and all dependencies:
```sh
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
```sh
rails db:setup
or
rails db:create
```
To run the project, execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
rails spec
```
### Local Deployment
[http://localhost:3000](http://localhost:3000)
| 👤 Name | Github | Twitter | LinkedIn |
| ------------------ | -------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------- |
| Christian Siku | [@Chrissiku](https://github.com/Chrissiku) | [@christian_siku](https://twitter.com/christian_siku) | [LinkedIn](https://www.linkedin.com/in/christian-siku/) |
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project!
I would like to thank [Microverse Inc](microverse.org) for the readme template used in this project
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._