rgxcp / wikalpa

🌵 [MAINTAINING] A wild wild west of Indonesian community driven discussion platform

🌵 Wikalpa

A wild wild west of Indonesian community driven discussion platform.

🚦 Status

MAINTAINING

📰 Table of Contents

Content
Status
Links
Requirements
How to: Setup Project
How to: Run Test Suite
How to: Run App on Local
How to: Run Dockerized App

🔗 Links

• Pivotal Tracker
• ERD
• Notion
• SwaggerHub
• Postman Workspace
• StackShare

🧾 Requirements

1. Git
2. Ruby
3. Bundler
4. PostgreSQL
5. Redis
6. Docker (Optional)
7. Docker Compose (Optional)
8. Postman (Optional)

🥋 How to

🔭 Setup Project

1. Clone the repository.

   $ git clone https://github.com/rgxcp/wikalpa.git
   

2. Add the following lines to your .bashrc, .zshrc, or any others shell configuration file for your machine setup.

   export RAILS_MASTER_KEY=
   export JWT_KEY=

3. Install the dependencies.

   $ bundle install
   

4. Setup the database.

   $ bin/rails db:setup
   

🔬 Run Test Suite

1. Make sure you have setup the project.
2. Run the test.

   $ bundle exec rspec
   

🏡 Run App on Local

1. Make sure you have setup the project.
2. Run the server.

   $ bin/rails s
   

3. Run Sidekiq.

   $ bundle exec sidekiq
   

🚢 Run Dockerized App (⚠️ NOT TESTED ⚠️)

1. Download the docker-compose.yml file and place it somewhere else.
2. Configure the required environment variables in it.

   - RAILS_MASTER_KEY=
   - JWT_KEY=
   - WIKALPA_DATABASE_PASSWORD=

3. Run the container.

   $ sudo docker-compose up -d
   

4. Setup the database.

   $ sudo docker exec wikalpa_api bin/rails db:setup
   

5. Run Sidekiq.

   $ sudo docker exec wikalpa_api bundle exec sidekiq