rex-9/ViaTick-Mapbox-Be

📗 Table of Contents

• 📗 Table of Contents
• 📖 [ViaTick Mapbox on Rails]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 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)
    • Usage
      • 7. Run the server on port 3001:
  • 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 [ViaTick Mapbox on Rails]

[ViaTick Mapbox on Rails] is the backend of the coding assignment assigned to my by ViaTick.

Frontend of this Project can be found here

🛠 Built With

Tech Stack

Client

• React.js Mapbox TailwindCSS Vite

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Add Pins to the Map
• Generate the nearest Routes

(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/ViaTick-Mapbox-Be.git

Install

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

you@your-Pc-name:~$ cd <ViaTick-Mapbox-Be>

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

Usage

To run the project, execute the following command:

7. Run the server on port 3001:

rails server

(back to top)

👥 Authors

👤 Rex

• Github: @rex-9
• Medium: @rex9
• LinkedIn: @rex9
• Facebook: @htetnaing0814
• Foundit: @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 Edmund@Viatick for giving the Inspiration and Funds to build this project.

(back to top)

❓ FAQ

• How did you create this Rails Backend 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)