📗 Table of Contents
📖 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
Server
Database
Key Features
- Conflict de-escalation cycle
🚀 Live Demo
💻 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:
👥 Authors
👤 Jingru Xu
👤 Ricky Mormor
- GitHub: @cwaku
- Twitter: @rickymormor
- LinkedIn: Ricky Mormor
🔭 Future Features
🤝 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
⭐️ Show your support
Give a ⭐️ if you like this project!
🙏 Acknowledgments
I would like to thank the following people for their support and guidance:
❓ FAQ
📝 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.