Skip to content
This repository was archived by the owner on Mar 20, 2024. It is now read-only.

Commit 57ae9dd

Browse files
committed
Increment version and update readme docs
1 parent 530a77b commit 57ae9dd

File tree

3 files changed

+120
-131
lines changed

3 files changed

+120
-131
lines changed

CONTRIBUTING.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,21 @@
22

33
Thank you for considering contributing to Timegrid.
44

5-
For being this a new and sprouting project, there are no strict rules for
6-
contribution, as long as they tend to attach to best practices.
5+
> Is it your first time ? Are you new to Laravel or PHP or Github ?
76
8-
For Coding Style please follow the
9-
[Laravel documentation](http://laravel.com/docs/contributions) guide.
7+
If you are willing to do your first time contribution, don't worry, you are welcome here.
8+
9+
While there is no strict guideline right now, you are welcome to bring your ideas and pull requests.
10+
11+
As a rule of the thumb, keep **PSR-2** and **tests** in mind.
12+
13+
Anyway, [contact me](https://timegrid.slack.com/home) and we will figure out your first steps into contributing :)
14+
15+
[Trello board for development roadmap](https://trello.com/b/VNFqnxhc/timegrid-io-dev)
16+
17+
[Dev Newsletter](http://eepurl.com/bF_ARX)
18+
19+
[![Join the chat at https://gitter.im/alariva/timegridDevelopment](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/alariva/timegridDevelopment?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1020

1121
# Reporting Issues
1222

INSTALLATION.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Installation
2+
3+
* [Step 1: Get the code](#step1)
4+
* [Step 2: Use Composer to install dependencies](#step2)
5+
* [Step 3: Create database](#step3)
6+
* [Step 4: Install](#step4)
7+
* [Step 5: Start Page](#step5)
8+
* [Optional: Populate DB with a Demo Fixture](#demosandbox)
9+
10+
<a name="step1"></a>
11+
## Step 1: Get the code
12+
13+
git clone https://github.com/alariva/timegrid.git
14+
15+
cd timegrid
16+
17+
-----
18+
<a name="step2"></a>
19+
## Step 2: Install dependencies with Composer
20+
21+
composer install
22+
23+
-----
24+
<a name="step3"></a>
25+
## Step 3: Create the Database
26+
27+
Once you finished the first three steps, you can create the *MySQL* database server. You must create the database with `utf-8` collation (`utf8_general_ci`), for the application to work.
28+
29+
-----
30+
<a name="step4"></a>
31+
## Step 4: Configure the Environment
32+
33+
**Copy** the **.env.example** file to **.env**
34+
35+
cp .env.example .env
36+
37+
**Edit** the `.env` file and set the database configuration among the other settings.
38+
39+
Set the application key
40+
41+
php artisan key:generate
42+
43+
**Edit** all the Primary section parameters (for *local/test/development environment*)
44+
45+
**Change** the storage path in **.env** file to a writeable location
46+
47+
STORAGE_PATH=/home/username/timegrid/storage
48+
49+
For **local** environment you will need to **comment out** APP_DOMAIN, to keep it *null*
50+
51+
#APP_DOMAIN=
52+
53+
Back to your console, **migrate** database schema
54+
55+
php artisan migrate
56+
57+
**Populate** the database:
58+
59+
php artisan db:seed
60+
61+
**Update** [geoip](https://github.com/Torann/laravel-geoip) database:
62+
63+
php artisan geoip:update
64+
65+
And we are ready to go. **Run** the server:
66+
67+
php artisan serve
68+
69+
**Type** on web browser:
70+
71+
http://localhost:8000/
72+
73+
-----
74+
<a name="step5"></a>
75+
## Step 5: Start Page
76+
77+
Congrats! You can now register as new user and log-in.
78+
79+
![timegrid Login Screen](http://i.imgur.com/jM8pbGq.png)
80+
81+
<a name="demosandbox"></a>
82+
## Demo Sandbox Fixture
83+
84+
If you want to try the application with a *Lorem Ipsum* database fixture.
85+
86+
php artisan db:seed --class=TestingDatabaseSeeder
87+
88+
Now you have two demo credentials to log in and play around.
89+
90+
USER: demo@timegrid.io
91+
PASS: demomanager
92+
93+
USER: guest@example.org
94+
PASS: demoguest

readme.md

+12-127
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
<a href="http://www.timegrid.io/">
2-
<img src="http://i.imgur.com/905Lv7L.png" alt="timegrid.io logo"
3-
title="timegrid.io" align="right" />
2+
<img src="http://i.imgur.com/905Lv7L.png" alt="timegrid.io logo" title="timegrid.io" align="right" />
43
</a>
54

65
timegrid
76
============
87

9-
> Online reservation of services for business. Made easy.
8+
> Online service booking made easy.
109
1110
[![Build Status](https://travis-ci.org/alariva/timegrid.svg?branch=development)](https://travis-ci.org/alariva/timegrid)
1211
[![Code Climate](https://codeclimate.com/github/alariva/timegrid/badges/gpa.svg)](https://codeclimate.com/github/alariva/timegrid)
1312
[![Test Coverage](https://codeclimate.com/github/alariva/timegrid/badges/coverage.svg)](https://codeclimate.com/github/alariva/timegrid/coverage)
1413
[![StyleCI](https://styleci.io/repos/45974720/shield)](https://styleci.io/repos/45974720)
15-
[![Version Stage](https://img.shields.io/badge/dev--beta-3.5.0-orange.svg?style=flat-square)](http://demo.timegrid.io/)
16-
[![ES User Manual](https://readthedocs.org/projects/manual-de-usuario-de-timegridio/badge/?version=latest&style=flat-square)](http://manual-de-usuario-de-timegridio.readthedocs.org/es/latest/?badge=latest)
14+
[![Current Stable](https://img.shields.io/badge/stable-3.6.0-green.svg?style=flat-square)](http://timegrid.io/)
15+
[![Current Beta](https://img.shields.io/badge/dev--beta-3.6.x-orange.svg?style=flat-square)](http://demo.timegrid.io/)
1716
[![License](https://img.shields.io/:license-AGPL--3.0-blue.svg?style=flat-square)](http://www.gnu.org/licenses/agpl-3.0.txt)
1817

1918
**The problem**
@@ -28,19 +27,17 @@ Built with the [**Laravel 5.1 (LTS)**](http://laravel.com/docs/5.1) framework fo
2827

2928
## Screenshots
3029

31-
![Dashboard Screenshot](http://i.imgur.com/aiG7jlx.png)
32-
![Appointment Screenshot](http://i.imgur.com/68dAS4f.png)
30+
![Dashboard Example Screenshot](http://i.imgur.com/aiG7jlx.png)
31+
![Appointment Example Screenshot](http://i.imgur.com/68dAS4f.png)
3332

3433
[Wanna see more?](https://github.com/alariva/timegrid/wiki/Screenshots)
3534

3635
## Live Demo
3736

38-
Want action? Try the *beta* [live demo](http://demo.timegrid.io/)
37+
Want action? Try the *beta-stable* [live demo](http://demo.timegrid.io/)
3938

4039
> **Hint:** To know which commit is in *demo*, you can hover the cursor on the leftmost label of the app footer.
4140
42-
> Now... Hold on tight! It's a bumpy ride for all of us!
43-
4441
## Features
4542

4643
### Implemented
@@ -53,7 +50,7 @@ Want action? Try the *beta* [live demo](http://demo.timegrid.io/)
5350
* Service Reservation
5451
* Local Search
5552

56-
### Future
53+
### Coming Soon
5754

5855
* Add SMS alerts
5956
* Add automatic vacancy handling
@@ -67,129 +64,17 @@ Want action? Try the *beta* [live demo](http://demo.timegrid.io/)
6764
* [![English Documentation Status](https://readthedocs.org/projects/timegrid-user-manual/badge/?version=latest)](http://manual-de-usuario-de-timegridio.readthedocs.org/en/latest/?badge=latest) English
6865
* [![Spanish Documentation Status](https://readthedocs.org/projects/manual-de-usuario-de-timegridio/badge/?version=latest)](http://manual-de-usuario-de-timegridio.readthedocs.org/es/latest/?badge=latest) Español
6966

70-
You are welcome to contribute.
71-
72-
-----
73-
## How to install:
74-
75-
* [Step 1: Get the code](#step1)
76-
* [Step 2: Use Composer to install dependencies](#step2)
77-
* [Step 3: Create database](#step3)
78-
* [Step 4: Install](#step4)
79-
* [Step 5: Start Page](#step5)
80-
* [Optional: Populate DB with a Demo Fixture](#demosandbox)
81-
82-
<a name="step1"></a>
83-
### Step 1: Get the code - Clone the repository
84-
85-
git clone https://github.com/alariva/timegrid.git
86-
87-
cd timegrid
88-
89-
-----
90-
<a name="step2"></a>
91-
### Step 2: Use Composer to install dependencies
92-
93-
composer install
94-
95-
-----
96-
<a name="step3"></a>
97-
### Step 3: Create the database
98-
99-
Once you finished the first three steps, you can create the *MySQL* database server. You must create the database with `utf-8` collation (`utf8_general_ci`), for the application to work.
100-
101-
-----
102-
<a name="step4"></a>
103-
### Step 4: Configure environment
104-
105-
**Copy** the **.env.example** file to **.env**
106-
107-
cp .env.example .env
108-
109-
**Edit** the `.env` file and set the database configuration among the other settings.
110-
111-
Set the application key
112-
113-
php artisan key:generate
114-
115-
**Edit** all the Primary section parameters (for *local/test/development environment*)
116-
117-
**Change** the storage path in **.env** file to a writeable location
118-
119-
STORAGE_PATH=/home/username/timegrid/storage
120-
121-
For **local** environment you will need to comment out APP_DOMAIN, to keep it *null*
122-
123-
#APP_DOMAIN=
124-
125-
Back to your console, migrate database schema
126-
127-
php artisan migrate
128-
129-
Populate database:
67+
## Installing
13068

131-
php artisan db:seed
132-
133-
Update [geoip](https://github.com/Torann/laravel-geoip) database:
134-
135-
php artisan geoip:update
136-
137-
You should be ready to go, now run the server:
138-
139-
php artisan serve
140-
141-
Type on web browser:
142-
143-
http://localhost:8000/
144-
145-
-----
146-
<a name="step5"></a>
147-
### Step 5: Start Page
148-
149-
Congrats! You can now register as new user and log-in.
150-
151-
![timegrid Login Screen](http://i.imgur.com/jM8pbGq.png)
152-
153-
<a name="demosandbox"></a>
154-
## Demo Sandbox Fixture
155-
156-
If you want to try the application with a *Lorem Ipsum* database fixture.
157-
158-
php artisan db:seed --class=TestingDatabaseSeeder
159-
160-
Now you have two demo credentials to log in and play around.
161-
162-
USER: demo@timegrid.io
163-
PASS: demomanager
164-
165-
USER: guest@example.org
166-
PASS: demoguest
69+
[Read the INSTALLING section](INSTALLING.md)
16770

16871
## Troubleshooting
16972

170-
I'd like to [hear your feedback](https://timegrid.slack.com/messages/general/).
171-
172-
Let me know if you face any inconvenient to install. I'm working on bringing a more comprehensive installation guide assessing common problems.
73+
I'm open to help out! Just [drop me your feedback](https://timegrid.slack.com/messages/general/).
17374

17475
## Contributing
17576

176-
Thank you for considering contributing to Timegrid.
177-
178-
> Is it your first time ? Are you new to Laravel or PHP or Github ?
179-
180-
If you are willing to do your first time contribution, don't worry, you are welcome here.
181-
182-
While there is no strict guideline right now, you are welcome to bring your ideas and pull requests.
183-
184-
As a rule of the thumb, keep **PSR-2** and **tests** in mind.
185-
186-
Anyway, [contact me](https://timegrid.slack.com/home) and we will figure out your first steps into contributing :)
187-
188-
[Trello board for development roadmap](https://trello.com/b/VNFqnxhc/timegrid-io-dev)
189-
190-
[Dev Newsletter](http://eepurl.com/bF_ARX)
191-
192-
[![Join the chat at https://gitter.im/alariva/timegridDevelopment](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/alariva/timegridDevelopment?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
77+
[Read the CONTRIBUTING section](CONTRIBUTING.md)
19378

19479
## Special Thanks
19580

0 commit comments

Comments
 (0)