Go to file
Danny Coates d63e22ab7e Merge pull request #162 from pdehaan/readme-dev-server
Fix dev server URL in README.md file
2017-07-10 09:35:47 -07:00
docs Update README with some more details 2017-06-26 12:43:08 -07:00
frontend/src hide table header on empty list 2017-07-05 09:56:38 -04:00
public Merge pull request #164 from mozilla/ui 2017-07-05 13:22:53 -04:00
scripts Move __version__ to a script 2017-06-23 16:53:17 -07:00
server lint 2017-06-30 09:47:50 -07:00
static naming improvements, stopped storing files by name on server 2017-05-30 16:34:00 -07:00
test remove notLocalHost 2017-06-23 20:01:32 -07:00
views hide table header on empty list 2017-07-05 09:56:38 -04:00
.dockerignore refactored docker build 2017-06-23 18:08:08 -07:00
.eslintignore Fix ESLint errors 2017-06-09 10:44:12 -07:00
.eslintrc.yml Fix a bunch of ESLint and HTMLLint errors 2017-06-22 09:49:45 -07:00
.gitignore Move __version__ to a script 2017-06-23 16:53:17 -07:00
.htmllintrc Add basic htmllint config 2017-06-09 10:25:15 -07:00
.stylelintrc Fix more stylelint and eslint errors 2017-06-22 09:54:34 -07:00
Dockerfile refactored docker build 2017-06-23 18:08:08 -07:00
LICENSE Add LICENSE file 2017-06-23 11:56:02 -07:00
README.md Change README.md server URLs to send.* 2017-07-06 12:12:01 -07:00
circle.yml build docker image with new name 2017-07-06 10:10:32 -07:00
docker-compose.yml added Dockerfile 2017-06-20 11:32:31 -07:00
package-lock.json bump version 2017-06-23 20:38:16 -07:00
package.json bump version 2017-06-23 20:38:16 -07:00

README.md

Firefox Fileshare

CircleCI

What it does

A P2P file sharing experiment which allows you to send encrypted files to other users.

Requirements

NOTE: To run the project, make sure you have a Redis server running locally:

$ redis-server /usr/local/etc/redis.conf

How to use it

Command Description
npm run dev Builds and starts the web server locally for development.
npm run format Formats the frontend and server code using prettier.
npm run lint Lints the CSS and JavaScript code.
npm start Starts the Express web server.
npm test Runs the suite of mocha tests.

Localization

Coming soon (see #57)

Contributing

Pull requests are always welcome! Feel free to check out the list of "good first bugs".

Testing

ENVIRONMENT URL
Production https://send.firefox.com/
Stage https://send.stage.mozaws.net/
Development https://send.dev.mozaws.net/

License

Mozilla Public License Version 2.0