This is a Readme For Frontend Part of the Application DSABook

• 1.   Introduction




      1.1   Motivation

      1.2   Technology

      1.3   How to Run this Project in your machine




• 2.   Deployment




      2.1   Deployment in Heroku

      2.2   Docker Image Deployed in Docker Hub

      2.3   How to Run this Docker image in your machine




1. Introduction




1.1 Motivation




In my Internship Program in Cefalo Bangladesh Limited I was asked to create a web Application having CRUD functionalities . I have named my CRUD application DSABook as it contains blogs regarding data Structures and algorithms .In this readme I will mainly describe everyting related to frontend part of DSABook web application .




1.2 Technology




React js :   A JavaScript library for building user interfaces
Material-UI :   A React UI framework
React Router :   a fully-featured client and server-side routing library for React
axios :   a Promise based HTTP client for the browser and node.js
moment.js :   Moment.js provides a wrapper for the native JavaScript date
and others...





1.3 How to Run this Project




Step 1 :


Make you you have Node and react installed in your machine . If not then install these in your machine



Step 2 :


Clone this Github Repository



git clone https://github.com/jagonmoy/Cefalo-Internship-ReactJs.git




Step 3 :




start the backend server and set the REACT_APP_BACKEND_URL_TEST of .env according to the PORT and HOST variable of config.env file of Backend




Step 4 :


make sure you have any package manager ( e.g npm,yarn etc) installed in your machine . Then run the following command

for npm



 npm install




Step 5 :


after doing all the steps now you can run the following command

for npm ,



npm start

if there is no error then it should run perfectly!!

2. Deployment




2.1 Deployment in Heroku




I have deployed backend and frontend part of DSABook separately in Heroku .

Frontend Part of DSABook Deployed in Heroku




2.2 Docker Image Deployed in Docker Hub




I have deployed image of backend and frontend part of DSABook separately in Docker Hub .

Image of Frontend Part of DSABook deployed in DockerHub




2.3 How to run This Docker image in your machine




Install Docker in your machine and do all the commands and procedure to start docker in your terminal . This might help you to install docker in your machine or you can find many youtube Tutorials .
After Installing Docker in your machine and starting docker in your terminal you can type following command .


docker run -it -p <port-number>:3000 -d jagonmoy/dsa-book-backend:<tag-name>

In place of port-number you will use any port number which is free and where you are wishing to run this application . In place of tag-name use the tag which has latest version.

suppose , you want to use the port number 3005 and the latest version is v2.0.0 then your command will be


​docker run -it -p 3005:3000 -d jagonmoy/dsa-book-backend:v2.0.0

Now you can visit frontend part of DSABook in : http://localhost:3005/