Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/croodles/schoolbook
An App for Schoolbook project
https://github.com/croodles/schoolbook
apache-cordova app cordova cross-platform multiplatform node npm open-source web
Last synced: about 14 hours ago
JSON representation
An App for Schoolbook project
- Host: GitHub
- URL: https://github.com/croodles/schoolbook
- Owner: croodles
- License: mit
- Created: 2024-09-01T06:59:40.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-09-06T06:03:18.000Z (5 months ago)
- Last Synced: 2025-02-01T05:26:03.419Z (1 day ago)
- Topics: apache-cordova, app, cordova, cross-platform, multiplatform, node, npm, open-source, web
- Language: CSS
- Homepage: https://govtschool.net
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Schoolbook
Schoolbook is a mobile application built using Cordova, designed to help students manage their education
## Installation
To run the project locally, you'll need to have [Node.js](https://nodejs.org/) and [Cordova](https://cordova.apache.org/) installed.
### Prerequisites
1. Install Cordova globally:
```bash
npm install -g cordova
```
2. Install platform-specific SDKs (Android/iOS) as required for the build.
### Clone the Repository
Clone this project to your local machine:
```bash
git clone https://github.com/croodles/Schoolbook.git
cd Schoolbook
```
### Add Platforms
You can add Android and iOS platforms using Cordova.
For Android:
```bash
cordova platform add android
```
For iOS:
```bash
cordova platform add ios
```
### Build the App
Build the application for the added platforms:
For Android:
Ensure you have the following installed:
- Android SDK
- JDK (Java Development Kit) – Version 8 or later
- Gradle – Version compatible with your Android SDK & JDK
```bash
cordova build android
```
For iOS:
```bash
cordova build ios
```
### Running the App
You can run the app on an emulator or a connected device:
For Android:
```bash
cordova run android
```
For iOS:
Require XCode
```bash
cordova run ios
```
## File Structure
- **www/**: This folder contains the HTML, CSS, and JavaScript files for the frontend.
- **platforms/**: Generated code for specific platforms like Android and iOS.
- **config.xml**: Configuration file for Cordova.
## Technologies Used
- **Cordova**: For cross-platform mobile development.
- **HTML5, CSS3, JavaScript**: Frontend technologies.
## Contributing
If you'd like to contribute to this project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix (`git checkout -b feature-name`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature-name`).
6. Open a Pull Request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.