SaneMyburg/rails-back-end

Greeting Back End

📗 Table of Contents

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

📖 [Random Greetings ]

Random Greetings is an rails backend api application.

Front-End Project

🛠 Built With

Tech Stack

• react.js
• ruby
• rails

Key Features

• Returns random selected greetings

(back to top)

💻 Getting Started

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

• Clone this repo as described in the setup section.
• Make modifications as peferred

Prerequisites

In order to run this project you need: To clone or fork and run it in a browser

Setup

Clone this repository to your desired folder:

Example commands:

  cd my-folder
  git clone https://github.com/SaneMyburg/rails-back-end.git

For more information on how to clone or fork a repository:

• How to clone a repo
• How to fork a repo

Install

• Run npm install for linters
• Run bundle install

Usage

To run the project, execute the following command:

• Run bundle exec rails server
• Run npm run build

Run tests

To run tests, run the following command:

• to test CSS linter errors npx stylelint "**/*.{css,scss}"

• to test ruby linter errors rubocop

• to test the classes rails c

(back to top)

👥 Author

👤 Sane Myburg

• GitHub: @SaneMyburg

🔭 Future Features

Future changes:

• Add animations and transitions
• Add more styles and colors

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• Thanks to all Microverse community

(back to top)

📝 License

This project is MIT licensed.

(back to top)