Skip to content

seanastephens/communityshare

 
 

Repository files navigation

Community Share

We're working on creating an application to connect educators with community partners.

See communityshare.us for more details.

Contributing

We currently develop community share locally by means of a Docker image. The image will boot up and load the current app, letting you make code changes without rebuilding the container. The first step is thus to install Docker on your computer. Please consult the Docker project or guides online for issues installing and running Docker.

Running a local development environment

Clone the reposity…

git clone https://github.com/communityshare/communityshare.git

…and then start the app.

cd communityshare

# via docker directly
docker-compose up

# or via npm
npm start

After this you should be able to see the servers initialize. You should be able to open up a browser to http://localhost:5000 and see the CommunityShare site.

If you experience any issues getting CommunityShare running locally, please file an issue and describe the problems you encountered.

Should you have need to inspect the running logs, they can be found mounted at /communitysharelogs within the Docker container. While the server is running, you can login to the container and explore:

docker-container exec server sh

Running the test suite

We currently have a working and primitive test suite. It should complete successfully before any PRs are merged.

# via docker
docker-compose run --rm server python /communityshare/tests.py

# via npm
npm test

Formatting

There is a script to format python files. It should be run before any python PR is merged.

npm run format

By default, this script formats every file in the project, which can take several seconds. You can pass filenames as an additional argument to format only some files, which is much faster.

npm run format app.py setup.py

About

An online network connecting educators with community partners

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 30.1%
  • CSS 24.3%
  • JavaScript 23.2%
  • HTML 22.3%
  • Other 0.1%