This project is an Expo-based mobile application developed as part of the Custos initiative. It is designed to run cross-platform on iOS and Android devices, leveraging the Expo framework for simplified setup and development.
- Expo: A framework that allows for building cross-platform applications in React Native with ease.
- React Native: The primary framework used to create mobile applications that work on both iOS and Android.
- JavaScript: The main programming language used in this application.
- React Navigation: Handles routing and navigation within the app.
- Node.js: Ensure Node.js is installed (recommended version >= 14.x).
- Expo CLI: Install Expo CLI globally using
npm install -g expo-cli.
Follow these steps to run the app locally.
-
Clone the repository:
git clone https://github.com/Custos-Diretriz/custos-mobile.git cd custos-mobile -
Install dependencies:
npm install
-
Start the app:
npx expo start
This command will open an Expo development environment. You can then open the app in:
- A development build
- An Android emulator or iOS simulator
- Expo Go for a quick preview
-
📂 File-based Routing: You can start development by editing files within the
appdirectory, as the project utilizes file-based routing.
-
Ensure dependencies are installed:
npm install
-
Run Tests:
npm testThis will run all test cases within the project, providing immediate feedback on the code quality and functionality.
All dependencies are defined in the package.json file. Here are some key dependencies:
- expo: The Expo framework for React Native apps.
- react-navigation: For managing in-app navigation.
- jest: Used as the testing framework.
To install all dependencies, use the following command:
npm installTo reset the project to its initial state:
npm run reset-projectThis command moves any existing starter code to the app-example directory and prepares a clean project setup.
- Fork the repository.
- Create a new branch (
git checkout -b feature/YourFeature). - Commit your changes (
git commit -m 'Add new feature'). - Push to the branch (
git push origin feature/YourFeature). - Open a Pull Request.
To learn more about developing your project with Expo, look at the following resources:
- Expo documentation: Learn fundamentals, or go into advanced topics with our guides.
- Learn Expo tutorial: Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.
Join our community of developers creating universal apps.
- Expo on GitHub: View our open source platform and contribute.
- Discord community: Chat with Expo users and ask questions.