/contact-importer

Primary LanguageRuby

Contacts Importer

Getting Started

This project was built using Ruby and Rails version 6, it is a web application and for running on your local environment you should follow these guidelines.

Prerequisites

  • Ruby 3.0.0
  • Rails 6.1.3,1
  • Git

Class Diagram

We have the next relationship for out project


Setup

The project repository can be found in GitHub link or just clone the project using this command.

Using SSH 

# git clone  https://github.com/rubenpazch/contact-importer.git

Using HTTPS

# git clone  git@github.com:rubenpazch/contact-importer.git
  • Open terminal on your workspace with
cd /home/workspace/contact-importer

Install

To get started with the app, clone the repo, and then install the needed gems:

# bundle install --without production

Next, migrate the database:

# rails db:migrate

$ rails server

Usage

To watch the local version of this project check on your browser for the link

Listening on tcp://127.0.0.1:3000

Examples CSV are here

examples file to test the are located in /examples folder inside of the applications

Run tests

Run the test suite to verify that everything is working correctly:

# bundle exec rspec

If the test suite passes, you'll be ready to run the app in a local server:

Tools used on this project

  • Visual Studio Code
  • VSCode Ruby by Stafford Brunk
  • Rspec
  • Faker
  • Factory Bot
  • CSV

Contributing

This project was created for educational purposes as part of the Microverse web development curriculum; contributing is not accepted.

Feel free to check the issues page.

Authors

👤 Ruben Paz Chuspe

Show your support

Give a ⭐️ if you like this project!

License

This project is licensed under the MIT License - see the LICENSE.md file for details