codehakase · codehakase · Jun 20, 2017 · Jun 12, 2017 · Jun 12, 2017 · Jun 12, 2017
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,13 @@
+language: php
+
+php:
+  - 7.0
+
+before_script:
+  - composer self-update
+  - composer install --no-interaction
+  - cp .env.example .env
+
+script:
+- php artisan key:generate
+- vendor/bin/phpunit
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Francis Sunday ⚡
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,63 @@
+# StudyLog
+A Study Log Web Application I built to log my progress during self created streaks.
+![studylog](https://user-images.githubusercontent.com/9336187/27025236-b28db472-4f51-11e7-825b-3d8fa2440af4.png)
+
+## Usage
+The main Concept of this app, is to create **Streaks**. Streaks are days related to a specific tag. The App allows one Log *Once* per day.
+
+## Config
+* Clone or download the Repo to your local Machine
+    ```bash
+    git clone [email protected]:codehakase/studyLog.git //SSH or
+
+    git clone https://github.com/codehakase/studyLog.git //HTTPS
+
+* create a `.env` file from the `.env.example` and update the environment variable with your details:
+    ```env
+    DB_CONNECTION=YOUR_DATABASE_DB_CONNECTION
+    DB_HOST=YOUR_DB_HOSST
+    DB_PORT=YOUR_DB_PORT
+    DB_DATABASE=DATABASE_TO_CONNECT_TO
+    DB_USERNAME=DB_USERNAME
+    DB_PASSWORD=DB_PASSWORD
+    .....
+
+    ```
+* Install the required packages
+  ```bash
+  composer install
+  ```
+
+* Run Migrations from your Terminal
+    ```bash
+    php artisan migrate
+    ```
+* Serve up your application
+   ```bash
+   php artisan serve
+   ```
+
+
+
+## TODOs
+* Notification on end of Streak
+* Tags History
+* Reports
+
+### Development
+* *Laravel* >= 5.4
+* *PHP* >= 5.6 (7 recommended)
+* *Homestead, Valet* - Optional
+* *Built-in Server*
+
+
+## Contributing 
+Please feel free to fork this repo and contribute by submitting a pull request to add features, or to make some corrections to them.
+
+
+## How can I thank you?
+Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or Facebook? Spread the word!
+
+and also, follow me on [twitter](http://twitter.com/codehakase)!
+
+Thanks! Francis Sunday.