This is the backend server software for nkw, a web application that lets users create sales postings and favorite them. In this repository you will find only the necessary components for the application backend, if you want to get the fronend up and running as well, please refer to this repository
First, you need to have the files on your computer. You can get them by either cloning this repository, or downloading its contents directly
- To clone the repository, go on the project's Github page, click on "Clone or download", copy the contents of the text box, and then run
git clone "repo"on the command line, where "repo" is the text you just copied. - If you want to download it directly instead, go on the project's Github page, click on "Clone or download", and then on "Download ZIP". After this, you need to extract the contents of the zip file on your computer.
Once you have the files on your computer, you need to make sure you meet the software requirements to run it (check the "Requirements" section below). Next, you need to navigate to the program's folder on your terminal.
Next up, you need to install the program's dependencies through bundler, by running the command:
bundle install
Once all dependencies are installed, migrate the database with the following commands:
rails db:migraterails db:seed
NOTE: Depending on the configuration and the permissions on your PostgreSQL installation, you might get an error message when the application cannot create the necessary databases. If that's the case, you need to manually create the following databases:
- nkw_backend_development
- nkw_backend_test
- nkw_backend_production
Here's a link that could be of help with this process.
This application uses ActiveStorage for application assets. By default, it uses AWS S3 storage services in production environments. If you plan on using S3, you need to set the following environment variables:
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- AWS_BUCKET_NAME
If you want to use the default disk service for production instead, update the following line in /config/environments/production.rb:
config.active_storage.service = :local
Run the following command to start the server:
rails server
Open a terminal on the base directory of the project and run the command rspec
- Ruby ~> 2.7
- Bundler ~> 2.1
- gem ~> 2.7
- PostgreSQL
- Ruby
- Ruby on Rails
- PostgreSQL
👤 Ivan Diaz
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.