https://github.com/boxuk/staff
Staff database for BoxUK that allows new starters and existing employees to learn more about their coworkers and quickly find contact information.
https://github.com/boxuk/staff
Last synced: 27 days ago
JSON representation
Staff database for BoxUK that allows new starters and existing employees to learn more about their coworkers and quickly find contact information.
- Host: GitHub
- URL: https://github.com/boxuk/staff
- Owner: boxuk
- Created: 2013-05-31T16:01:49.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2013-09-02T20:48:15.000Z (almost 13 years ago)
- Last Synced: 2025-01-06T02:20:17.777Z (over 1 year ago)
- Language: CSS
- Homepage:
- Size: 309 KB
- Stars: 3
- Watchers: 48
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Staff
An online staff directory for Box UK employees inspired by this blog post from Etsy.
http://codeascraft.com/2013/05/31/culture-hacking-with-a-staff-database/
This is part of a mobile app built by maxehmookau at
https://github.com/maxehmookau/staff-ios
There are so many new starters in Box UK it gets hard to keep track of new hires. It's also nice for new starters in a company to be able to get more information about who is who to prevent the awkward not knowing who to ask type situations.
Staff allows people to look up email addresses, find out information about what people are into, see who works where and quickly find the right person to answer their questions.
## Running the app
Staff is a Play2 application. You will need Scala, Postgres and SBT installed.
To get started
+ download the most recent version of Play2
+ git clone git@github.com:boxuk/staff.git
+ cd staff
Create the postgres db
+ createdb staff
Run the application
+ play run
## Deploying the app
This application is built to run on Heroku easily. To deploy an instance to heroku run
```
heroku create --remote production
git push heroku production
# Check the logs if you have any issues
heroku logs
# Connect to the console
heroku run sbt play
```
## API
### Employees
Get all employees
```
GET /api/employees
```
Get a single employee by ID
```
GET /api/employees/:id
```
Get all employees with a given role (i.e all designers, developers etc)
```
curl -X GET -i http://localhost:9000/api/employees/roles/1
```
### Search
You can search for employees by first and last name
```
curl -X GET -i http://localhost:9000/api/search?q=jack
```
## Deployment
Staff is deployed and running on Heroku using Postgres
```
git push heroku master
```