Skip to content

Latest commit

 

History

History
62 lines (59 loc) · 2.88 KB

README.md

File metadata and controls

62 lines (59 loc) · 2.88 KB
Raw

SchoolRoom

logo

This is a MVP (Minimum Viable Product) in development phase for a school management software designed to help educational institutions manage their different classes and courses

running app 1 running app 2

Tech Stack

  • React Native + Expo

  • Typescript

  • Redux (Global State Handling)

  • React Native Paper (UI Components Library)

  • Tailwind (Styles Handling)

  • Jest (Unitary Tests)

  • ESlint (Code Guidelines)

  • Prettier (Code Formatting)

  • Github Actions Workflows

Project Guide

To run the "SchoolRoom" project, follow these steps:

  1. Ensure that you have Node.js and npm installed on your system.
  2. Clone the repository to your local machine.
  3. Navigate to the project directory.
  4. Install project dependencies with npm run install.
  5. Start the development server:
  • To run the project on Android, use: npm run android.
  • To run the project on iOS, use: npm run ios.
  • To run the project on the web, use: npm run web.
  1. You can also run tests using the command: npm test.
  2. To check and format the code according to project guidelines, you can use the following commands:
  • Check code formatting: npm run format:check.
  • Automatically format the code: npm run format.
  1. For linting the code, you can use the following commands:
  • Check for linting issues: npm run lint.
  • Automatically fix some linting issues: npm run lint:fix.

Update guide

To update the dependencies of the "SchoolRoom" project, consider the following tools:

  1. Highly Recommended: https://docs.expo.dev/workflow/upgrading-expo-sdk-walkthrough/
  2. https://docs.expo.dev/bare/upgrade
  3. Use with care after Expo Upgrade: https://www.npmjs.com/package/npm-check-updates Don't update libs updated by Expo
  4. If app doesn't run, this might help: https://react-native-community.github.io/upgrade-helper
  5. If app doesn't run, this might help: https://medium.com/game-development-stuff/how-to-easily-upgrade-react-native-and-the-project-dependencies-6af458ada81c