From 4743cae61460d229f49d090df5a340add59e8c3f Mon Sep 17 00:00:00 2001 From: anijit Date: Thu, 30 Dec 2021 12:50:53 +0530 Subject: [PATCH] README file is update --- README.md | 58 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 32 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 0d8f53d..8619134 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,26 @@ # react-app-simple-music-app -A Simple Music Application using [React JS](https://reactjs.org/docs/getting-started.html), a JavaScript library to make awesome UI by Facebook, [Node JS](https://nodejs.org/en/docs/), [Express JS](https://expressjs.com/en/api.html) and [MongoDB](https://docs.mongodb.com/). + +A Simple Music Application using [React JS](https://reactjs.org/docs/getting-started.html), a JavaScript library to make awesome UI by Facebook, [Node JS](https://nodejs.org/en/docs/), [Express JS](https://expressjs.com/en/api.html) and [MongoDB](https://docs.mongodb.com/). This application uses [React JS](https://reactjs.org/docs/getting-started.html) component oriented UI creation paradigm. All components are written in [JSX](https://reactjs.org/docs/jsx-in-depth.html) and ES6 style and are -combined to get a single build for production purpose using [Webpack 5](https://webpack.js.org/concepts/). +combined to get a single build for production purpose using [Webpack 5](https://webpack.js.org/concepts/). -ES6 `module` creation along with `import /export` is used. [Babel](https://babeljs.io/docs/en/babel-preset-react) is used to *transpile* all [JSX](https://reactjs.org/docs/jsx-in-depth.html) code to vanilla JavaScript code. To install all the dependecies `npm` is used. +ES6 `module` creation along with `import /export` is used. [Babel](https://babeljs.io/docs/en/babel-preset-react) is used to _transpile_ all [JSX](https://reactjs.org/docs/jsx-in-depth.html) code to vanilla JavaScript code. To install all the dependecies `npm` is used. For UI creation [HTML5](https://www.w3schools.com/html/html5_intro.asp) and [CSS3](https://www.w3schools.com/css/) are used. [Grid](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout), the new feature of [CSS3](https://www.w3schools.com/css/) is used for layout creation purpose. -Back end is implemented using [Node JS](https://nodejs.org/en/docs/), [Express JS](https://expressjs.com/en/api.html) and [MongoDB](https://docs.mongodb.com/). [Atlas](https://www.mongodb.com/cloud/atlas), the *Cloud* version of [MongoDB](https://docs.mongodb.com/) +Back end is implemented using [Node JS](https://nodejs.org/en/docs/), [Express JS](https://expressjs.com/en/api.html) and [MongoDB](https://docs.mongodb.com/). [Atlas](https://www.mongodb.com/cloud/atlas), the _Cloud_ version of [MongoDB](https://docs.mongodb.com/) is used. -This is a *responsive web application* for viewing in both Mobile and Desktop. - +This is a _responsive web application_ for viewing in both Mobile and Desktop. ## Features -- Code is rewritten with [React JS 17](https://reactjs.org/docs/getting-started.html) and [Node JS 15](https://nodejs.org/en/docs/) -- Latest features of JavaScript i.e. ES6, ES7, ES8 is used -- [React JS Hooks](https://reactjs.org/docs/hooks-intro.html) are used with Functional components -- ES8 `async/await` is used + +- Code is rewritten with [React JS 17](https://reactjs.org/docs/getting-started.html) and [Node JS 17](https://nodejs.org/en/docs/) +- Latest features of JavaScript i.e. ES6, ES7, ES8 is used +- [React JS Hooks](https://reactjs.org/docs/hooks-intro.html) are used with Functional components +- ES8 `async/await` is used +- Routing is rewritten using [React Router v6](https://reactrouter.com/docs/en/v6)
@@ -27,8 +29,7 @@ This is a *responsive web application* for viewing in both Mobile and Desktop.
  • It is a Full Stack Application
    • -- All the song details are stored in the [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). This is a *free/ shared* account on [Atlas](https://www.mongodb.com/cloud/atlas). **So Please use it wisely** - +- All the song details are stored in the [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). This is a _free/ shared_ account on [Atlas](https://www.mongodb.com/cloud/atlas). **So Please use it wisely** -- Information about the song (Movie, Album, Artist) is available on click of the `i` icon -- Changing the rating is supported -- All the ratings are saved in the database i.e. *persistant* -- Listing of Top 5 songs *based on their rating* is available - +- Information about the song (Movie, Album, Artist) is available on click of the `i` icon +- Changing the rating is supported +- All the ratings are saved in the database i.e. _persistant_ +- Listing of Top 5 songs _based on their rating_ is available ## Installation Clone the repository: + ``` git clone https://github.com/anijitsahu/react-app-simple-music-app.git -``` -Navigate inside the directory: +``` + +Navigate inside the directory: + ``` cd react-app-simple-music-app ``` + Install all the necessary dependecies: + ``` npm install -``` +``` + Run the server: + ``` npm run server ``` -Open the web browser and type`http://localhost:3000` in the address bar to load the application - -*tested with [Google Chrome 89](https://www.google.com/chrome/) and [Mozilla Firefox 86](https://www.mozilla.org/en-US/firefox/new/)* + +Open the web browser and type`http://localhost:3000` in the address bar to load the application + +_tested with [Google Chrome 89](https://www.google.com/chrome/) and [Mozilla Firefox 86](https://www.mozilla.org/en-US/firefox/new/)_ ## Screenshots -Some screens of the application is given below for better understanding. +Some screens of the application is given below for better understanding. Desktop as well as Mobile version of the screenshots are given side by side. @@ -94,5 +102,3 @@ Desktop as well as Mobile version of the screenshots are given side by side.

    - -