Kalend

KO | EN

gitlite — search

#typescript #python #javascript #reactjs #rust #openai #nodejs #react #css #android #java #linux

★ 21 Open GitHub ↗

AI-Powered Student Calendar Planner

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[<img src="https://raw.githubusercontent.com/CDH-Studio/Kalend/dev/src/assets/img/dark_logo.png" alt="Kalend" width="300"/>](https://benjeau.github.io/)

[![CircleCI](https://img.shields.io/circleci/project/github/CDH-Studio/Kalend/master.svg?style=flat&logo=circleci)](https://circleci.com/gh/CDH-Studio/Kalend)
[![Release Version](https://img.shields.io/github/release/CDH-Studio/Kalend.svg?style=flat)](https://github.com/CDH-Studio/Kalend/releases)
![](https://img.shields.io/github/license/CDH-Studio/Kalend.svg?style=flat)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/CDH-Studio/Kalend.svg)

A mobile application that leverages Artificial Intelligence technology to create optimized schedules while taking into account various user constraints as well as other information such as the location of activities and their duration. Our project demo website is available [here](https://benjeau.github.io/).

## Dependencies

Below is a list of development dependencies to run the project, you can either install all of them manually or run the PowerShell script.

* [Yarn](https://yarnpkg.com/)
* [Node.js](https://nodejs.org/)
* [JDK](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
* [React Native](https://facebook.github.io/react-native/docs/getting-started#installing-dependencies)
* [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) (for iOS development)
* [Android Studio](https://developer.android.com/studio) (for Android development)
* Android SDK (for Android development, needed for React Native)
  * Android SDK Platform 28
  * Android SDK Build-Tools 28.0.3
  * Sources for Android 28
  * Intel x86 Emulator Accelerator (HAXM installer)

### Manual install

A basic install of [React Native](https://facebook.github.io/react-native/docs/getting-started#installing-dependencies) should be fine to run this project.

### Automatic install (windows only)

If you have none of the dependencies listed above and want to install from scratch, located at the root of this project, there is a file called **setup.ps1** in the config folder. To install via the script:

1. Open a PowerShell window with Administrator privileges.
2. Run `Set-ExecutionPolicy RemoteSigned` to be able to run the PowerShell script. Then enter **a** when asked for an input.
3. Run `cd config`, then `.\script.ps1` to run the script. Follow the instructions displayed in PowerShell when running the script

## Getting up and running

Make sure to install every development dependencies mentionned above before proceding.

1. Clone the repo `git clone https://github.com/CDH-Studio/Kalend.git`
2. Change directory `cd Kalend`
3. Install project dependencies `yarn install` or just `yarn`
    * **Note**: if you want to test it on iOS, you need to install pod dependencies by doing `cd ios && pod install`
4. Run the application
    1. In the debug environment
        * On Android `yarn android` or `react-native run-android`
        * On iOS `yarn ios` or `react-native run-ios`
    2. In the release environment
        * On Android `yarn android-release` or `react-native run-android`
        * On iOS `yarn ios-release` or `react-native run-android`

**Note**: to get the Google Sign In working on the debug version of Android, you need to replace the *debug.keystore* located in .android folder of your home directory by the project's keystore file located in the project's android folder.

The code for the backend part of this project is located in another [repository](https://github.com/CDH-Studio/Kalend-backend), which contains the code necessary for the server-side part of the project.

#### Go to our [wiki](https://github.com/CDH-Studio/Kalend/wiki) for more information

Kalend

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README