project-elaichi
Description
This is the development repository for campus guide at NIT Rourkela.
🚀 Installation Guide
-
Install Flutter on your machine
Install flutter by selecting the operating system on which you are installing Flutter:
To check if you have flutter installed along wtih proper necesarry SDKs installed run
flutter doctor
-
Clone the Repo
To clone this repository, run
git clone https://github.com/developer-student-clubs-nitr/project-elaichi.git
Then runcd project-elaichi
-
Get Packages Make sure you are in the
project-elaichi/elaichi
directory- From the terminal: Run
flutter pub get
. OR - From Android Studio/IntelliJ: Click Packages get in the action ribbon at the top of
pubspec.yaml
. - From VS Code: Click Get Packages located in right side of the action ribbon at the top of
pubspec.yaml
.
- From the terminal: Run
-
Test the App
Make sure you are in the
project-elaichi/elaichi
directory.Run the App
On terminal:
- Check that an Android device is running by running
flutter devices
. If none are shown, follow the device-specific instructions on the Install page for your OS. - Run the app with the following command:
flutter run
- Check that an Android device is running by running
Congrats 🥳 ! You just ran the Project Elaichi App. Feel free to use the app in whatever way possible and make sure to send us feedbacks and suggest changes.
Project Structure
- data - Manages the API and Local data
- domain - Manages the business logic of the application
- presentation - Manages the UI, routing and blocs
Contributing
We are open to suggestions, bug-reporting and features! We would love to see you contribute but make sure you follow our Contributing Guidelines.