-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added installation instructions and navigation
- Loading branch information
1 parent
fe9544b
commit d6ab1cd
Showing
1 changed file
with
62 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,93 @@ | ||
| # Dealscover London | ||
|
|
||
|  | ||
|
|
||
| ## About The Project: | ||
| <h2 align="center"> | ||
| <a href="#about-the-project">About |</a> | ||
| <a href="#features">Features |</a> | ||
| <a href="#getting-started">Getting Started |</a> | ||
| <a href="#acknowledgements">Acknowledgements</a> | ||
| </h2> | ||
|
|
||
| Our aim is to make London accessible to everyone, regardless of their budget. We created a full stack application to filter events by specific categories such as sports, music, festivals, food, and much more. This makes it easier for our users to find events that cater to their interests and preferences. The event website for students, young people, and anyone who wants to experience London without breaking the bank. | ||
| # About The Project | ||
|
|
||
| ### Our aim is to make London accessible to everyone, regardless of their budget. | ||
| ### We created a full stack application to filter events by specific categories such as sports, music, festivals, food, and much more. | ||
| ### This makes it easier for our users to find events that cater to their interests and preferences. | ||
|
|
||
| ## Video Demonstration: | ||
| # Features | ||
|
|
||
| ## Tech Stack | ||
| ### This application was built using a MERN stack with React-app. Core features include: | ||
|
|
||
| ### ● Data Fetching API's using Axios | ||
| ### ● Form Handelling | ||
| ### ● User Authentication with JsonWebToken | ||
| ### ● State Management | ||
| ### ● User Searches and Filters | ||
|
|
||
| ### Backend | ||
| | | | | ||
| | ----------- | ----------- | | ||
| |  |  | | ||
| |  |  | | ||
|
|
||
| ### Frontend | ||
|   | ||
|    | ||
|
|
||
| | | | | ||
| | ----------- | ----------- | | ||
| || | | ||
| | || | ||
|
|
||
|   | ||
|  | ||
|
|
||
| | Testing | | | ||
| | ----------- | ----------- | | ||
| | |  | | ||
| <h2 align="right"> | ||
| <a href="#about-the-project">back to top ▲</a> | ||
| </h2> | ||
|
|
||
| # Getting Started | ||
|
|
||
|
|
||
| ### Clone this repository: | ||
| >`git clone HusnainRashid/london-on-a-budget` | ||
| ### Install the dependencies for the server: | ||
|
|
||
| Design: | ||
| >`cd london-on-a-budget/server && npm install` | ||
| ### Install the dependencies for the client: | ||
| > ` cd london-on-a-budget/client && npm install` | ||
| ### Add your your MongoDB connection string to the server/bin/www directory: | ||
|
|
||
|  | ||
|  | ||
| > `MONGODB_URI=your-connection-string` | ||
| ### Start the server | ||
|
|
||
| >`london-on-a-budget git:(main) cd server` | ||
| >`server git:(main) JWT_SECRET=SUPER_SECRET npm start` | ||
| ### Start the client | ||
| >`london-on-a-budget git:(main) cd client` | ||
| >`client git:(main) npm start` | ||
| Dependencies Management: | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
|
|
||
| --- | ||
| ### Running Tests: | ||
|
|
||
|  | ||
| >`npm test` | ||
| Launches the test runner in the interactive watch mode.\ | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
|
|
||
| ## Getting Started: | ||
|   | ||
|
|
||
| To work with the code, once you have cloned the repository: | ||
|
|
||
| ```terminal | ||
| ➜ london-on-a-budget git:(main) cd server | ||
| ➜ server git:(main) JWT_SECRET=SUPER_SECRET npm start | ||
| ``` | ||
| <h2 align="right"> | ||
| <a href="#about-the-project">back to top ▲</a> | ||
| </h2> | ||
|
|
||
| ```terminal | ||
| ➜ london-on-a-budget git:(main) cd client | ||
| ➜ client git:(main) npm start | ||
| ``` | ||
| # Acknowledgements | ||
|
|
||
|  | ||
|  | ||
|
|
||
| - Monday | ||
| - Slack | ||
| - GitLens | ||
| - Adobe Logo Creator | ||
|
|
||
| This will automatically open up a development version of the site at localhost:3000 | ||
| <h2 align="right"> | ||
| <a href="#about-the-project">back to top ▲</a> | ||
| </h2> |