/Lyrical-Labyrinth

Lyrical Labyrinth is a captivating platform that celebrates the art of writing, offering a sanctuary for poets, storytellers, and article enthusiasts. Immerse yourself in the creative journey as you navigate through the intricacies of words and emotions. Escape into the realm of creativity, where words paint vivid pictures and emotions come to life

Primary LanguageRubyMIT LicenseMIT


LYRICAL LABYRINTH

📗 Table of Contents

📖 Lyrical Labyrinth

Lyrical Labyrinth is a captivating platform that celebrates the art of writing, offering a sanctuary for poets, storytellers, and article enthusiasts. Immerse yourself in the creative journey as you navigate through the intricacies of words and emotions. Escape into the realm of creativity, where words paint vivid pictures and emotions come to life.

🛠 Built With

Tech Stack

Server
  • Ruby
  • Rails
    • Database
  • Postgres

    • Key Features

    • Poetry Playground: Craft and share your poetic masterpieces in an environment tailored for lyrical expression.

    • Storyteller's Haven: Weave intricate narratives and share your stories with a community passionate about the written word.

    • Reflective Articles: Explore reflections on life, love, and the human experience through thought-provoking articles.

    • Find articles by category or type

    (back to top)

    🚀 Live Demo

    COMING SOON

    (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 >= 3.2.0
    rails >= 7.0
    postgres >- 15.3

    Setup

    Clone this repository to your desired folder:

        git clone  git@github.com:marvin-nyalik/LyricalLabyrinth.git

    You need to setup database for these project

      development = lyrical_labyrinth_development
  test        = yrical_labyrinth_test

    or you can use your own database and change the config/database.yml

      default: &default
    adapter: postgresql
    encoding: unicode
    pool: 5
    username: [your_username]
    password: [your_password]
    host: localhost

  development:
    <<: *default
    database: [your_database_for_development]

  test:
    <<: *default
    database: [your_database_for_test]

  production:
    <<: *default
    database: [your_database_for_production]

    Install

    Install this project with:

      cd LyricalLabyrinth
  bundle install

    it will install the required gems for running the project

    Usage

    to use this project:

       rails server -p 3000

    it will run the server on localhost:3000

    (back to top)

    👥 Author

    👤 Marvin Otieno

    (back to top)

    🔭 Future Features

    • Allow User Registration
    • Add writer communities
    • Engage stakeholder support

    (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 star and follow on github for more projects like this

    (back to top)

    🙏 Acknowledgments

    • Major appreciations to Heart and Soul for inspiring the development and design of this project.
    • I'd also like to thank Microverse for defining the linting configurations used in this project

    (back to top)

    📝 License

    This project is MIT licensed.

    (back to top)