Skip to content

Commit bd5f98e

Browse files
authored
Update README.md
1 parent 4a564ff commit bd5f98e

File tree

1 file changed

+17
-24
lines changed

1 file changed

+17
-24
lines changed

README.md

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,24 @@
1-
# mern-template-project
1+
# Spotify Recommender
22

3-
# Setup A New Project From This Template
43

5-
If you are starting a new project do the following:
4+
## Overview
5+
The goal of this project was to create a full stack spotify application tht could reccomend songs to users based on 10 categoiries of loudness, energy, danceability, loudness, mode, speechiness, acousticness, instrumentalness, liveness, valence, tempo.
66

7-
1. copy/download this directory to where you new project is located and rename
8-
it to the name of your project.
9-
1. change your directory (`cd`) into the copied project template
10-
1. `npm install`
11-
1. `npm run dev`
12-
1. Open a new browser window and navigate to the URL http://localhost:3000/
13-
here you should see `hello world` displayed after page load
14-
updates should show up here automatically
15-
1. see the `client/src` `readme.md` file for more information on the react project
7+
## Challenges
8+
- Storing the user access and passing it through props to the necessary components
169

17-
# Setup A New Project Without This Template
1810

19-
If you want to start a project without using this template directory do the
20-
following:
11+
## Technologies Used
12+
- Backend --> Express, Mongoose, NodeJs, TensorFlow
13+
- Frontend --> Bootstrap 4, JavaScript, React.js, Spotify APi
2114

15+
## Acknowledgements
16+
-CSS Tricks for the fad in animation
17+
18+
### Contributers
19+
https://github.com/KPPhiri
20+
21+
## Future Developments/Improvements
22+
### Phase 2
23+
- Create a music player that the end user can use.
2224

23-
1. `mkdir <project-name>`
24-
1. `cd <project-name>`
25-
1. `echo "# <project-name>" > readme.md`
26-
1. `git init`
27-
1. `git add readme.md `
28-
1. `git commit -m "init repo with readme.md"`
29-
1. `npm init`
30-
1. `mkdir models views controllers`
31-
1. `touch ./server.js`

0 commit comments

Comments
 (0)