📗 Table of Contents

• 📗 Table of Contents
• 📖 Closer
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Closer

Closer is a relationship wellness tool that lets individuals track and navigate through their conflict cycles to reflect on what lies underneath their behaviours and primary emotions. These insights about their partners and themselves will allow couples to break the negative cycles and strengthen their relationship.

🛠 Built With

Tech Stack

Client

• Ionic Framework
• React.js
• Typescript

Server

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• Conflict de-escalation cycle

(back to top)

🚀 Live Demo

• Live Demo Link

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

- Ruby
- Ruby on Rails
- PostgreSQL
- Node.js
- npm
- Ionic CLI
- IDE (VSCode, Xcode, Android Studio)

Setup

Clone this repository to your desired folder:

  cd closer
  git clone https://github.com/Co-Lab-You-Belong-in-Tech/closer.git

Install

Install the frontend with:

Install the backend with:

Usage

To run the frontend of the project, execute the following command:

  cd closer
  npm install
  npm start

• Navigate to the app on your browser with the url http://localhost:**** where **** is the port number displayed on your terminal.

To run the backend of the project, execute the following command:

  cd closer
  cd backend
  bundle install
  rails db:create
  rails db:migrate
  rails db:seed
  rails s

• Navigate to the app on your browser with the url http://localhost:**** where **** is the port number displayed on your terminal.

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Jingru Xu

• GitHub: @jxu710
• LinkedIn: Jingru Xu

👤 Ricky Mormor

• GitHub: @cwaku
• Twitter: @rickymormor
• LinkedIn: Ricky Mormor

(back to top)

🔭 Future Features

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

• Clone the repo with the command git clone https://github.com/Co-Lab-You-Belong-in-Tech/closer.git
• Pick an issue from the issues page and assign it to yourself
• Create your own branch from develop, eg feat/
• Ensure your branch is up to date with latest changes before pushing
• Create a pull request against develop branch
• Reference the issue you worked on in your PR
• Wait for your PR to be reviewed and merged

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank the following people for their support and guidance:

• Ingrid
• Grace

(back to top)

❓ FAQ

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