rex-9/ChibiURL

The URL shortening Service including URL customization and Analytics

📗 Table of Contents

• 📗 Table of Contents
• 📖 [React on Rails]
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Video Presentation
    • Screenshots
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
      • 1. Navigate to the location of the folder in your machine:
      • 2. Install the gems:
      • 3. Set up the database with your credentials:
      • 4. Create the databases:
      • 5. Migrate the databases:
      • 6. Seed the dummy data: (Optional)
      • 6. Install NPM packages:
      • 7. Build and Watch Tailwindcss:
    • Usage
      • 7. Run the server:
    • Run tests
  • 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Chibi URL

Chibi Url - the Url shortening service.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Display URLs (including how many times the link is clicked)
  • My URLs
  • Public URLs
• Copy URLs
• Create URLs (with Error Handling)
• Delete Owned URLs
• Sign In
• Sign Up
• Sign Out

Video Presentation

• Video Demo

(back to top)

Screenshots

• Public URLs Page

• Public URLs Page

• Sign In Page

• Sign In Page

• Sign Up Page

• Public URL

• Create Chibi URL Page

• Public URL

• My URLs Page

• Public URL

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

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/rex-9/ChibiURL.git

Install

1. Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd <ChibiURL>

2. Install the gems:

bundle install

3. Set up the database with your credentials:

• setup the database environment in

config/database.yml

4. Create the databases:

rails db:create

5. Migrate the databases:

rails db:migrate

6. Seed the dummy data: (Optional)

rails db:seed

6. Install NPM packages:

npm i

7. Build and Watch Tailwindcss:

rails tailwindcss:watch

Usage

To run the project, execute the following command:

7. Run the server:

rails server

Run tests

To run tests, run the following command:

Example command:

  bin/rails rspec spec

(back to top)

👥 Authors

👤 Rex

• Github: @rex-9
• Medium: @rex9
• LinkedIn: @rex9
• Facebook: @htetnaing0814
• Angelist: @rex9

(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, please kindly offer me opportunities for further contributions.

(back to top)

🙏 Acknowledgments

I would like to thank Helpjuice for giving the Inspiration and Opportunity to build this project.

(back to top)

❓ FAQ

• How did you create this Chibi URL step by step?

  • You can check my commit history. I did as simple as I could. If it's hard to understand, you can easily reach out to me.

(back to top)

📝 License

This project is MIT licensed.

(back to top)