lucaswilliamgomes/medium_api

Backend based on Medium to publish articles, stories and thoughts.

Medium

Backend based on Medium to publish articles, stories and thoughts.

• Prerequisites
• Installation
• Usage
• Contributing

Prerequisites

• Ruby (version 3.2.2)
• Ruby on Rails (version 7.0.4)
• PostgreSQL (version 14.7)

Installation

1. Clone the repository:

git clone https://github.com/your-username/your-project.git

2. Install dependencies:

bundle install

3. Create and migrate the database:

rails db:create
rails db:migrate

Usage

1. Start the Rails server

rails server

2. Open your browser and navigate to http://localhost:3000 to access the application.

Contributing

Contributions are welcome! If you find any bugs or want to improve the project, please follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b my-feature.
3. Make the necessary changes and commit them: git commit -am 'Add some feature'.
4. Push to the branch: git push origin my-feature.
5. Submit a pull request.