CollAction is the world's first official crowdacting platform that aims to solve collective action problems with the ultimate goal of having positive social and ecological impact. Copyright (C) 2020, Stichting CollAction
Docker is the easiest way to get this running:
docker-compose build
docker-compose up -d
You can also run our services outside docker.
To run the backend you need:
- dotnet core 5.0 or higher
- Visual Studio or Visual Studio code can be used to run the project. If you don't like IDEs you can use
dotnet runto run it through the command line.
For debugging the backend in Visual Studio code do the following:
- Open the folder ./CollAction in Visual Studio Code
- Create .env file from template
- Install the official C# extension for Visual Studio Code
- Press Ctrl + Shift + D followed by F5
To run the frontend you need:
- A recent version of npm and yarn
- To install the dependencies run
yarn - To run the project in development mode, use
npm run start
Our backend is build using ASP Core 3.1. We use:
- GraphQL.net for our APIs together with:
- GraphiQL for development
- GraphQL.EntityFramework to retrieve the data
- Hangfire to run background jobs
- Serilog to handle our logging
- ImageSharp for image processing
- MSTest/Moq for testing
- Postgres to store our data
Our frontend is build using react. We use:
- Fontawesome/Fortawesome for icons
- Apollo client for GraphQL interaction
- Material UI
- Formik to handle form validation
- Node SASS for our css
- react-dropzone for a file upload UI
- react-slick/slick-carousel for our project carousel
We use the following external services:
- Netlify to host our frontend
- Amazon ECS + EC2 to host our backend
- Stripe to receive donations
- Amazon S3 to host our project images
- Amazon SES to send transactional e-mails
- Mailchimp for maillists
We're using BrowserStack for our front-end testing!
When you run the site, you can configure the following settings through either environment variables or dotnet-secrets:
- DbUser: The postgres user
- DbPassword: The postgres password
- DbHost: The postgres host
- Db: The postgres database
- SeedTestData: Seed the database with random test data (true or false)
- PublicAddress: The 'public' address where the frontend is hosted. This is used for links back to the frontend (in e-mails and endpoints). In production we use CORS and other validation to enforce this.
- AdminPassword: The admin password used for the admin user
- AdminEmail: The admin e-mail address used for the admin user
- MaxNumberProjectEmails: How many project e-mails can project-owners send (defaults to 4)
- MaxImageDimensionPixels: The maximum image dimension (either width or height) a project image can have (defaults to 1600)
- MailChimpTestListId: The mailchimp list-id used for integration tests
- MailChimpNewsletterListId: The mailchimp list-id used to subscribe users
- MailChimpKey: The secret mailchimp key used to access the MailChimp API
- S3Region: The S3 region used to host our images
- S3Bucket: The S3 bucket-name used to host our images
- S3AwsAccessKeyID: The AWS access key ID we use to access the S3 API
- S3AwsAccessKey: The AWS access key we use to access the S3 API
- SesRegion: The region we host SES in
- SesAwsAccessKeyID: The AWS access key ID we use to access the SES API
- SesAwsAccessKey: The AWS access key we use to access the SES API
- FromAddress: The from-address we use for our SES e-mails
- StripePublicApiKey: The stripe public (shareable) key used to access the stripe API
- StripeSecretApiKey: The stripe secret (non-shareable) key used to access the stripe API
- StripeChargeableWebhookSecret: The webhook secret used for the chargeable endpoint (pings back when we can initiate a payment)
- StripePaymentEventWebhookSecret: The webhook secret used for the event endpoint (used for logging stripe events)
- NumberSeededCrowdactions: How many crowdactions are seeded
- NumberSeededTags: How many tags are seeded
- NumberDaysSeededForComments: How many days worths of comments are seeded per crowdaction
- ProbabilityCommentSeededPerHour: Per hour, what are the odds a comment is seeded
- ASPNETCORE_URLS: Which ports/protocols to expose (example: https://*:44301)
- ASPNETCORE_ENVIRONMENT: Which environment are we hosting in (Development/Staging/Production)
Our test configuration files contain configuration enough to get a minimum version of the site up for development and testing, they don't contain any secrets. When creating a pull-request, be careful about checking in production secrets. Use dotnet-secrets for secrets/keys that shouldn't be in git.
If you want to contribute to this project, e-mail [email protected].