Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rafaelcamargo/4dayweek
A collaborative list of companies friendly to the 4-day workweek.
https://github.com/rafaelcamargo/4dayweek
company four-day-week list
Last synced: 2 months ago
JSON representation
A collaborative list of companies friendly to the 4-day workweek.
- Host: GitHub
- URL: https://github.com/rafaelcamargo/4dayweek
- Owner: rafaelcamargo
- Created: 2022-11-04T15:28:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T01:35:12.000Z (7 months ago)
- Last Synced: 2024-11-01T19:36:46.976Z (3 months ago)
- Topics: company, four-day-week, list
- Language: JavaScript
- Homepage: https://4dayweek.rafaelcamargo.com/
- Size: 572 KB
- Stars: 10
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- fucking-lists - 4dayweek - day workweek. (Non-technical)
- lists - 4dayweek - day workweek. (Non-technical)
README
# 4 day week
> A list of companies friendly to 4 day workweek
[](https://dl.circleci.com/status-badge/redirect/gh/rafaelcamargo/4dayweek/tree/main)
[](https://coveralls.io/github/rafaelcamargo/4dayweek?branch=main)
## Contributing
1. Install [Node](https://nodejs.org/en/). Download the "Recommend for Most Users" version.
2. Clone the repo:
``` bash
git clone [email protected]:rafaelcamargo/4dayweek.git
```
3. Go to the project directory
``` bash
cd 4dayweek
```
4. Install the project dependencies
``` bash
npm install
```
5. Create a `.json` in `src/companies/data` containing the following data:
``` javascript
{
"name": String,
// [Required] Company's name.
"adoption": String,
// [Required] "Full" or "Partial".
// Full: Company adopts 4-day week for everyone during the whole year.
// Partial: Company adopts 4-day week with restrictions (e.g. During summer only).
"website": String,
// [Required] Company's website.
"careers_page": String,
// [Required] Company's careers page.
"description": String,
// [Required] Brief description on how company applies 4-day week.
"origin": String,
// [Optional] City/Country where company has been founded (e.g. Chicago, USA).
"created_on": String,
// [Required] Date you you are creating the file.
"updated_on": String
// [Optional] Date you are updating the file.
}
```
6. Check your changes running the command below and accessing `http://localhost:9000`:
``` bash
npm run start
```
## Tests
1. In case you have changed any website behavior, ensure that all changes are covered with automated tests:
``` bash
npm run test
```
2. You can optionally generate a coverage report while running tests:
``` bash
npm run test -- --coverage
```