/nc-portfolio-fe

๐Ÿ“ฑ An app for Northcoders graduates, allowing them to showcase work in a centralised space [Northcoders final project]

Primary LanguageJavaScript

๐ŸŽ“ Northcoders Portfolio ๐Ÿ“ฝ๏ธ



newsstand


Hello! ๐Ÿ‘‹ Welcome to our app - Northcoders Portfolio.


๐Ÿ’ญ Description

Northcoders Portfolio is an app to help Northcoders graduates upload short video demonstrations of their projects to a centralised space that recruiters and employers can efficiently access and browse.

Typically, graduates are limited in visibility due to the size of their network or limited reach due to a change in sector. Additionally, recruiters and employers have limited time and resources, which further adds to the issue of visibility. We built this app with these challenges in mind, to alleviate frictions or barriers to visibility: allowing graduates to showcase their work, as well as reducing the workload on the employer side in finding newly-qualified graduates.

๐Ÿค” What Does It Do?

Users can:

  • โœ๐Ÿป Sign up as a new user
  • ๐Ÿ” Log in as an existing user
  • ๐Ÿ“– Create and update their user bio (including external links to work: e.g. GitHub)
  • ๐Ÿ”ผ ๐Ÿท๏ธ Upload new videos from their device's gallery (adding tags, title and video description)
  • ๐Ÿ“บ View all videos in a Tik-Tok style feed
  • ๐Ÿ” ๐Ÿท๏ธ Filter videos by video tags
  • ๐Ÿ  View a dedicated user video feed in their profile
  • ๐Ÿ‘ Vote on videos
  • โœ… ๐Ÿ—‘๏ธ Add and delete their comments on videos
  • ๐Ÿ‘€ Access other user's profiles
  • ๐Ÿ—‘๏ธ Delete their own videos

๐Ÿงช Technology

  • The app is built using React Native โš›๏ธ

  • We've used Cloudinary as our cloud storage provider, which are brought down and rendered using the Expo-AV video player

  • Calls to the API are performed using Axios

  • User authentication is achieved by storing hashed passwords on the backend and using bcrypt to compare and verify the hashed passwords

๐Ÿ–ฅ๏ธ Running the App Locally

๐Ÿšง Before beginning setup, please check you have at least these versions of the following:

  • node - v. 16.13.1

After doing so, perform each step, in order:

๐Ÿ’ป โžก๏ธ ๐Ÿ’ป Cloning the repository

git clone https://github.com/davidptclark/nc-portfolio-fe.git

๐Ÿ—๏ธ Install required packages

Simply run npm install to install the necessary dependencies required.

๐Ÿ–ฅ๏ธ ๐Ÿ“ฒ Building and running the site

To build and run the site on your local machine, run npm start. After doing so, you'll need to use either the Expo Go app on your mobile device or an iOS/Android emulator on your local machine to run the app.