Skip to content

cbfacademy/full-stack-javascript-assessment-nuramhassan

Repository files navigation

RainBowNoir

Table of Contents generated with DocToc

Purpose: About RainBowNoir

RainBowNoir is a wed-based platform that offers a secure and transparent environment for comprehensive reviews of companies and products. Our assessments encompass broad categories like amenities while also integrating specific insights from neurodiverse individuals. These unique perspectives illuminate details that others might overlook or undervalue.

Why the project is useful

It allows the integratiom specific insights from marginalized communities such as Black, queer, or neurodiverse individuals. These diverse perspectives shed light on nuanced details that might be overlooked or underestimated by others, enriching the depth and accuracy of our reviews.

How users can get started with the project

Folder Navigation

For both frontend and backend folders i have given detailed information to potray my logic in the ReadMe's in each corresponding folder for example App.jsx & Main.jsx are in the src folder The corresponding Readme can be found in the root frontend folder.

Launch the app to a live environment

Use the Link: https://full-stack-javascript-assessment-nuramhassan.vercel.app/

Locally running the app

  1. From the frontend folder run:

npm install

This will ensure that all package dependencies needed to run, test and build the app are downloaded from the internet first.

Once done, you can run any of the following commands:

npm run dev

Runs the backend insuring the DB is ready and Node is running.
Open http://localhost:5173 to view it in your browser.

To quit running the app, press Ctrl+C

2. From the backend folder run:

npm install

This will ensure that all package dependencies needed to run, test and build the app are downloaded from the internet first.

Once done, you can run any of the following commands:

npm run start-dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

To quit running the app, press Ctrl+C

Design

UI Design

🔗Figma Link

Initially my design included a Login, Signup, & Forgotten Password Page for added security, However due to time constraints it was not implimented

User Story

The User Flow and explanation can be found in User Flow Folder

Tech

TechStack

  1. ✅Frontend: Utilise React for creating user interfaces, Tailwind for Styling
  2. ✅Backend: Build an API using Node.js and Express.js
  3. ✅Database: MongoDB for data storage, Imagebb for Image storage (Due to memory constraints i had to seperate the 2 databases as not to slow down the app
  4. ✅Deployment: backend : https://backend-rn-deployment.onrender.com frontend: https://full-stack-javascript-assessment-nuramhassan-deployment.vercel.app/

Challenges & Feedback

image Initially i designed multiple pages and inputs but due to authentication issues i descided to remove it.

Things to improve

Login/Signup functionality work, but asked for authentication. I think it would also help if i specified what images we are able to upload, because only png images worked (jpg).

Help & Credits

Where users can get help with your project

Contact

Nura Hassan - [email protected]

Project Link: Repo Link

(back to top)

Acknowledgments

About

full-stack-javascript-assessment-nuramhassan created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published