https://github.com/shoaibrayeen/profile-management-system

This repository contains A Web Application developed in Ruby on Rails with PostgreSQL on the basis of the requirements.
https://github.com/shoaibrayeen/profile-management-system

elasticsearch elasticsearch-client elasticsearch-cluster elasticsearch-dsl postgres postgresql rails-application redis redis-cache redis-server ruby ruby-on-rails sidekiq sidekiq-cron sidekiq-scheduler

Last synced: 3 months ago
JSON representation

This repository contains A Web Application developed in Ruby on Rails with PostgreSQL on the basis of the requirements.

Host: GitHub
URL: https://github.com/shoaibrayeen/profile-management-system
Owner: shoaibrayeen
License: apache-2.0
Created: 2020-01-24T11:06:21.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-03-09T01:29:18.000Z (about 2 years ago)
Last Synced: 2025-01-14T11:46:55.012Z (4 months ago)
Topics: elasticsearch, elasticsearch-client, elasticsearch-cluster, elasticsearch-dsl, postgres, postgresql, rails-application, redis, redis-cache, redis-server, ruby, ruby-on-rails, sidekiq, sidekiq-cron, sidekiq-scheduler
Language: Ruby
Homepage:
Size: 2.64 MB
Stars: 8
Watchers: 1
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: readMe.md
- License: LICENSE

Awesome Lists containing this project

README

## Profile Management System

### Overview
- Profiles are user accounts(seller/buyers in context of E commerce / Any selling buying company etc) which are created to save information regarding users to server them better in a system. Generally it compromised with APIs to get/create/update profiles of users and a panel to view/search/edit profiles by admins.
- For more details - [Requirements](./requirement.md)

### Getting Started with Project
Prerequisite
- Rails Version 5.1.7
- Ruby 2.4.1
- Elasticsearch Server for Searching
- Sidekiq for Background Processing
- PostgreSQL for Database
- Redis for Caching and to use along with Sidekiq

Clone the repository
```sh
> git clone https://github.com/shoaibrayeen/Profile-Management-System
> cd Profile-Management-System
```
Setting up with PostgreSQL
```
# Create a database user with your PostgreSQL Terminal
# Go to config -> database.yml
and change these two details according to your database user
username: userName
password: PASSWORD
```

Install required dependencies
```sh
> bundle install
```

Creating Database for Development and Testing Environment
```sh
> bundle exec rake db:drop
> bundle exec rake db:create
> bundle exec rake db:migrate
```

Starting with App
```
# To Start Elastic Search Server
> sudo -i service elasticsearch start

# To Start Sidekiq Server - Redis-Server needed to run sidekiq
> bundle exec sidekiq

# To run the app
> bundle exec rails server

# Now go to your browser and run
localhost:3000
# Your app is running
```
To check all the routes
```sh
> rake routes
```

To Use Model
```sh
# To see all the database using PostgreSQL
> bundle exec rails db
postgres >>> SELECT * FROM TABLE_NAME;

# To see all the database using Rails console
> rails c
> model_name.all

```

To Use Postman API
```sh
# After Starting Server
# Go to POSTMAN APP

GET localhost:3000/api/get_profile #Give id and get Information

POST localhost:3000/api/signup #Give related information in the body and it'd validate accordingly

POST localhost:3000/api/signin #Give email and password in the body and it'd validate accordingly

```

## Demo of the Project

Use Portal