diff --git a/README.md b/README.md index c6c9f7890..f1f2a1999 100644 --- a/README.md +++ b/README.md @@ -38,25 +38,101 @@ The purpose of CodeFolio is to create a centralized platform where developers ca ## Features -### [Name of Feature 1] +### [User Authentication] -[short description goes here] +Users can create an account, log in securely, and access personalized features using authentication such as JWT or OAuth [gif goes here] -### [Name of Feature 2] +### [User Profile Creation] -[short description goes here] +Users can create and edit a developer profile that includes their bio, tech stack, location, and social links. [gif goes here] -### [Name of Feature 3] +### [Project Uploading] -[short description goes here] +Users can upload and manage projects by adding a title, description, images or GIFs, and external links such GitHub or live demos. [gif goes here] -### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them] +### [Project Feed] + +Users and visitors can browse a feed of uploaded projects to discover work shared by other developers. + +[gif goes here] + +### [Project Detail Page] + +Users can click on a project to view more detailed information, including the project description, walthrough visuals, and related links. + +[gif goes here] + +### [Search Functionality] + +Users can search for projects by title or keyword to quickly find projefcts related to their interests. + +[gif goes here] + +### [Commenting on Projects] + +Logged-in users can comment on projects to ask questions, give feedback, or interact with other creators. + +[gif goes here] + +### [CRUD Functionality] + +Users can create, read, update, and delete their own profiles, projects post, and comments within the app. + +[gif goes here] + +### [Connection Requests] + +Users can send and receive connection requests to build their network and connect with other developers. + +[gif goes here] + +### [Project Filtering by Category or Tag] + +Users can filter projects by categories such as web development, mobile apps, data science or game development. + +[gif goes here] + +### [Like Projects] + +Users can like projects to show appreciation and increase engagement on the platform. + +[gif goes here] + +### [Bookmark or Save Projects] + +Users can save projects they are interested in so they can revisit them later. + +[gif goes here] + +### [Notifications] + +Users can receive notifications for actions such as new connection requests, accepted requests, or comments on their projects. + +[gif goes here] + +### [Map-Based Location Display] + +Users can display their state or country using a map API to make profiles more interactive and location aware. + +[gif goes here] + +### [Collaboration Discovery] + +Users can discover and connect with developers based on shared interests, goals, or project types for easier collaboration. + +[gif goes here] + +### [Portfolio Feedback Features] + +Users can receive UI/UX or projefct feedback from others to improve the quality of their portfolio and showcased work. + +[gif goes here] ## Installation Instructions