README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 notion_clone

notion_clone is an application that allows you to enter text and convert the test to a heading or paragraph element when the text is preceded by '/1' or '/+1' respectively. It is built with Ruby on Rails and containerized with Docker.

🛠 Built With

Tech Stack

Client

• Ruby on Rails
• Ruby
• Docker

Database

• PostgreSQL

🚀 Live Demo

• Click here to go live.

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

 install docker

 Install docker-compose

 Install code editor e.g VSCode

Setup

Clone this repository to your desired folder:

  git clone https://github.com/PNdunguMaina/notion_clone.git

Usage

To run the project, execute the following command:

  docker-compose up --build

Configure

Navigate to this directory:

  cd notion_clone

Configure the database:

  Open database.yml file

  -database: your database name
  -username: your postgres user
  -password: your postgres user password
  -host: database container (notion_clone-db-1)
  -port: your port(e.g 5432)

Run on server

You can run this project on live server on your local machine using:

  http://localhost:3000/

(back to top)

👥 Authors

👤 Author1

• GitHub: @PNdunguMaina
• LinkedIn: Patrick Maina
• Portfolio: Portfolio

(back to top)

🔭 Future Features

• Login page
• New user registration page

(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 give it a star on Github.

(back to top)

🙏 Acknowledgments

I would like to acknowledge HelpJuice.

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