Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

๐Ÿ“ฑ The mobile app for Student Scoop, inspired and built for the FBLA 2024 mobile application event.

Notifications You must be signed in to change notification settings

Student-Scoop/Mobile-App-FBLA

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

4 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

โš ๏ธ Old Repository
The contents of this repository have been archived, since a majority of the commits made here were from a previous competition. All new commits and versions can be found here: https://github.com/Student-Scoop/Mobile-App

Student Scoop Mobile

FBLA Mobile Development 2023-2024

By Maebe-Rose Vanderbeek & Bryan Lawless

Our Website ยท Report Bug ยท Request Feature


๐Ÿ“œ About the Project

Student Scoop is a school oriented social media and portfolio platform for students. Students and schools can compete in challenges, post updates, share their work, and showcase their academic accomplishments.


(back to top)


๐Ÿ“ Requirements Met

Our project meets the following requirements from the guidelines stated here: FBLA Mobile Application Rubric.

  • Users can easily navigate between pages.
    • The user can use the bottom navigation bar to navigate between pages.
  • User interface is intuitive or clear instructions are provided.
    • The user interface is easy to understand and the functionaility is familiar.
  • Icons/graphical elements are appropriate and consistent
    • All icons have been designed to be consistent with the theme of the app.
  • User input is validated.
    • All user input is validated on the app and on the server before being stored or manipulated.
  • Integrated with social media
    • Our app uses Google and Facebook for single sign on.

(back to top)


๐Ÿงฐ Core Technologies Used

Technology Description Link
NodeJS Runtime environment for JavaScript https://nodejs.org/en/
TypeScript Static typing for JavaScript https://www.typescriptlang.org/
React Native Framework for building cross platform mobile apps https://reactnative.dev/
Expo An ecosystem of tools to help aid development for React Native apps https://expo.dev/
React Query Asynchronous state management and data fetching https://tanstack.com/query/v3/

(back to top)


๐Ÿ”ง Installation

Prerequisites

  • NodeJS 16+
  • Android Studio (Recommended)
  1. Clone the repo git clone https://github.com/Student-Scoop-FBLA/Mobile-App.git
  2. Open a terminal in the cloned folder.
  3. Run npm install in the ./Mobile-App folder.
  4. Open the file ./constants/config.ts and change the BACKEND_API_URL value to the URL of the backend server.
  5. Once configured, run npm start and run the app on your device or emulator.

(back to top)


๐Ÿ’พ Inner Workings

Coming Soon


๐Ÿงน Code Formatting and Structure

Coming Soon


๐Ÿšง Future Road Map

  • Add support for social media integration.
  • Add support for push notifications.
  • Create a better system for components and screens.
  • Create a more unified global state management system.

See the open issues for a full list of proposed features as well as known issues.

(back to top)


๐Ÿ“œ License

Distributed under the GNU Affero General Public License v3.0. See LICENSE for more information.

(back to top)


๐Ÿช™ Acknowledgments

(back to top)