You can find the deployed project at www.ourneighborhoodchef.com
| Kyle Richardson | Paul Edwards | Aaron Merrifield-Lucier | Brennan Neilson | Patrick Replogle | Miguel Leal |
|---|---|---|---|---|---|
 |
 |
 |
 |
 |
 |
 |
|
|
|
|
|
Neighborhood Chef provides a uniquely intimate approach to social culinary gatherings, allowing for both the creation and attending of culinary events in your neighborhood.
- Culinary event creation
- join/RSVP open events
- embraces javascript-based programming
- interacts with DOM via JSX
- supports immutability that Redux enforces
- provides immutability in state management for reliability
- allows for scalability of application
- provides a structured workflow of state management
- service for the storing and authentication of user accounts
- provides improved layers of security with a multifactor PCKE authorization flow and secure methods of authenticating a user after log in (via introspection requests)
Back end built using:
- embraces javascript-based programming
- when grouped with basic middlewares (Helmet, CORS, Compression, Multer, JSON), provides robust server structure
- easily scalable
- simple, easy to read queries and data retrieval
- very efficient queries
- predictable in what will be provided
- fully capable and diverse with many different index types
- open source source code for visibility
- allows full support for SSL and other security measures
- atomic and consistent
Robust and trusted authentication platform that is easily integrated into React front end as well as NodeJS backend frameworks
In order for the app to function correctly, the user must set up their own environment variables. Please refer to the .env.example file contained within the src folder for a list of up to date environment variables. You will need to create a new .env file on the root level to match the variables in the example file.
| Image Filename | Source / Creator | License |
|---|---|---|
| (none) |
Jest library used in tandem with React Testing Library is sufficient to perform meaningful unit tests for our application, allowing near full test coverage.
yarn install or npm install to install all necessary dependencies locally.
* start - sets up the development environment and starts a server
* test - runs tests found within the full application (*.test.js file extensions)
* build - creates a 'build' directory with the production build of the app
* eject - copy the configuration files and dependencies into the project so you have full control over them
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.