zamcham / ThoughtTrail

ThoughtTrail Blog

📗 Table of Contents

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

ThoughtTrail

"ThoughtTrail" is a captivating Ruby on Rails blog application that invites users to embark on a journey of self-expression and storytelling. Within this digital haven, individuals can share their thoughts, experiences, and imaginative tales, crafting a unique trail of narratives.

ERD diagram

The structure of ThoughtTrail application is based on the ERD diagram below:

🛠 Built With

Tech Stack

Client

• HTML/CSS

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User Registration and Authentication: Allow users to sign up for accounts and log in securely.
• User Profiles: Enable users to create and customize their profiles, including profile pictures and bio.
• Create, Edit, and Delete Blog Posts: Allow users to write, edit, and delete their blog posts.
• Rich Text Editor: Provide a user-friendly rich text editor for composing blog posts with formatting options.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Ensure you have Ruby installed on your system. You can check by running the code below in your terminal.

  ruby --version

Setup

Clone or download the Beyond Borders repository to your local machine.

  git clone [e-mail]:zamcham/ThoughtTrail.git

Open your terminal and navigate to the cloned project directory.

Install

This project does not require additional dependencies, just Ruby interpreter. However, it uses RuboCop as a linter and you should set it up as well.

bundle install

Usage

• To run Beyond Borders, run the following command:

  rails s

Open your browser and navigate to:

  http://localhost:3000/

(back to top)

👥 Author

👤 Cristian Zambrano

• GitHub: @zamcham
• LinkedIn: Cristian Zambrano

🔭 Future Features

• User Interface
• Forms

(back to top)

🤝 Contributing

Contributions to the User Interface are welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue on the project repository.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give us a star ⭐️

(back to top)

🙏 Acknowledgments

Special thanks to our team and the Ruby community for their support and contributions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)