Skip to content

Commit 55c9480

Browse files
authored
Merge pull request #138 from VCGithubCode/lk-prideful-branch
edit readme
2 parents c586eb4 + 0fa6ef1 commit 55c9480

File tree

10 files changed

+58
-20
lines changed

10 files changed

+58
-20
lines changed

README.md

Lines changed: 58 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,15 @@ The project is deployed and can be accessed at [https://prideful-programmers-01c
4040
4. [Tools](#tools)
4141
5. [Supporting Libraries and Packages](#supporting-libraries-and-packages)
4242
7. [Methodology](#methodology)
43-
8. [Future Features](#future-features)
44-
9. [Deployment](#deployment)
45-
10. [Performance](#performance)
46-
11. [Code Validation](#html-validation)
43+
8. [Features](#features)
44+
9. [Future Features](#future-features)
45+
10. [Deployment](#deployment)
46+
11. [Performance](#performance)
47+
12. [Code Validation](#html-validation)
4748
1. [HTML Validation](#html-validation)
4849
2. [CSS Validation](#css-validation)
49-
12. [Credits](#credits)
50-
13. [Acknowledgements](#acknowledgements)
50+
13. [Credits](#credits)
51+
14. [Acknowledgements](#acknowledgements)
5152

5253

5354
## Introduction
@@ -259,32 +260,69 @@ The Inclusive Spots website was created utilizing agile methodologies to boost t
259260

260261
[Return to Table of Contents](#table-of-contents)
261262

262-
## Future Features
263+
## Features
263264

264-
### Resources Page with Interactive Map
265-
We are planning to introduce a comprehensive Resources page to provide users with essential information and links to helpful venues categorized into Cafes, Support Centers, and Clubs. This page aims to support the community by offering easy access to places that promote inclusivity and support.
265+
### Landing page, Header and Footer
266+
![Header](documentation/images/features\Header.png)
267+
![upper landing page](documentation/images/features/landing-upper-fold.png)
268+
![lower landing page](documentation/images/features/landing-bottom-fold.png)
269+
![Footer](documentation/images/features/footer.png)
266270

267-
Additionally, we plan on implementing pagination in the future in order to render the Venues page more user-friendly.
271+
- The landing page greets the user with a quick introductory paragraph noting the purpoes of the website. It is split into two main sections, separated by a background image in the middle of the page.
272+
- The users are then invited to proceed onto the main Venue page upon clicking one of the four buttons provided.
273+
- The Header has the development team's logo and the Website's name to the left and the navigation bar to the right. On Mobile screens it becomes a burger bar.
274+
- The Footer has a copyright and the Website's name which acts as an anchor to return the user to the landing page. The social buttons are styled to provide a better visual effect.
275+
276+
### The Venues page
277+
- The main venue page lists three categories: cafes, bars/clubs and support centres. Depending on which button the user selected on the landing page, they will be taken to the filtered list of venues.
268278

269-
## Categories
270279

271-
### Cafes
280+
#### Categories
281+
282+
Additionally, we plan on implementing pagination in the future in order to render the Venues page more user-friendly.
283+
284+
##### Cafes
272285
Welcoming environments ideal for socializing, working, or relaxing. Known for inclusive policies and a friendly atmosphere.
273286

274-
### Support Centers
287+
##### Support Centers
275288
Essential services and support for mental health, career counseling, and community assistance. Safe spaces dedicated to helping individuals navigate challenges.
276289

277-
### Clubs
290+
##### Clubs
278291
Social and recreational activities fostering community and belonging, including sports clubs, book clubs, and social groups.
279292

280-
## Features
281-
Search and Filter: Easily search for specific venues or filter by category.
282-
Detailed Information: Venue listings include address, contact info, opening hours, and special features.
283-
User Reviews: Users can leave reviews and ratings for venues.
293+
Each venue includes the following:
294+
- Search and Filter: Easily search for specific venues or filter by category.
295+
- Detailed Information: Venue listings include address, contact info, opening hours, and special features.
296+
297+
### The About page
298+
- The about page contains a list of developers for the user to see who has contributed to the project and also allows to connect with them via Github or LinkedIn platforms.
284299

300+
### The Contact page
301+
- The contact page allows the user to submit an enquiry form to the website. Upon completion a thank you note appears indicating to the user that their enquiry has been submitted.
302+
303+
![contact page](documentation/images/features/contact-upper.png)
304+
![contact page](documentation/images/features/contact-lower.png)
305+
306+
### 404 & 500 Error pages
307+
- Error pages have been included to ensure that the user is notified in case there are any bugs or errors occuring that prevent the user to access the content they intended.
308+
- Each page have a button taking the user back to the landing page.
309+
310+
- 404 error page image
311+
![404 page](documentation/images/features/error404.png)
312+
313+
- 500 error page
314+
![500 page](documentation/images/features/error404.pngdocumentation/images/features/error505.png)
315+
316+
[Return to Table of Contents](#table-of-contents)
317+
318+
## Future Features
319+
320+
### Resources Page with Interactive Map
321+
- We are planning to introduce a comprehensive Resources page to provide users with essential information and links to helpful venues categorized into Cafes, Support Centers, and Clubs. This page aims to support the community by offering easy access to places that promote inclusivity and support.
322+
- To enhance user experience, an interactive map feature will be integrated, allowing users to visualize the location of each venue with functionalities like geolocation, pins and markers, info windows, map filters, and directions.
285323

286-
## Interactive Map
287-
To enhance user experience, an interactive map feature will be integrated, allowing users to visualize the location of each venue with functionalities like geolocation, pins and markers, info windows, map filters, and directions.
324+
### User Reviews
325+
- Users can leave reviews and ratings for venues.
288326

289327
[Return to Table of Contents](#table-of-contents)
290328

28 KB
Loading
Loading
Loading
914 KB
Loading
914 KB
Loading
54.9 KB
Loading
Loading
Loading
1.19 MB
Loading

0 commit comments

Comments
 (0)