Giter Club home page Giter Club logo

mobile-app-fbla's Introduction

โš ๏ธ 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)

mobile-app-fbla's People

Contributors

bryanlawless avatar deepsource-io[bot] avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.