Backend delpoyed at https://delphe-backend.herokuapp.com
To get the server running locally:
- Clone this repo
yarn installto install all required dependenciesyarn serverto start the local serveryarn testto start server using testing environment
- allows us to build a relational database using knex and sqlite.
- allows us to create out own middleware wherever neccessary.
- allows for easy integration with our React app.
- allows us to create modular, RESTful APIs to call on from our React app.
(selective access to endpoints is handled on Frontend)
| Method | Endpoint | Description |
|---|---|---|
| POST | /register |
posts a new user to database |
| POST | /login |
finds registered user in database |
| Method | Endpoint | Description |
|---|---|---|
| GET | / |
returns all users in database |
| GET | /:id |
returns single user info by id |
| GET | /:id/questions |
returns single user info by id with user's questions and answers to questions |
| DELETE | /:id |
deletes a single user by id |
| PUT | /:id |
edits single user info by id |
| Method | Endpoint | Description |
|---|---|---|
| GET | / |
returns all questions in database |
| GET | /:id |
returns single question info by id with array of its answers and array of its topics |
| POST | / |
adds a new question to database |
| DELETE | /:id |
deletes a single question by id |
| PUT | /:id |
edits a single question by id |
| Method | Endpoint | Description |
|---|---|---|
| GET | / |
returns all answers in database |
| GET | /:id |
returns single answer info by id |
| POST | / |
adds a new answer to database |
| DELETE | /:id |
deletes a single answer by id |
| PUT | /:id |
edits a single answer by id |
| Method | Endpoint | Description |
|---|---|---|
| GET | / |
returns all topics in database |
| GET | /question |
returns all records in question_topics database |
| POST | / |
finds a topic in database |
| POST | /question |
adds new record to question_topics table |
{
"id": 1,
"first_name": "Jane",
"last_name": "Doe",
"username": "janedoe",
"password": "password",
"email": "jane@company.com",
"bio": "I'm a primary school counselor with a passion for advancing our youth -- especially those who are under-served. I'm hoping to start an after-school program students interested in STEM! Looking for any resources or leads to make this possible!",
"image_url": null,
"user_type": "asker",
"hourly_rate": null
}
{
"id": 5,
"first_name": "Jenny",
"last_name": "Hen",
"username": "jennyhen",
"password": "password",
"email": "jenny@company.com",
"bio": "I have a lot of experiences and want to help others get the answers the need!",
"image_url": null,
"user_type": "expert",
"hourly_rate": 15
}
{
"id": 1,
"user_id": 1,
"title": "After-school STEM Program",
"question": "What are some cool online resources for 3rd graders interested in STEM?",
"date": "June 3, 2019",
"created_at": "2019-06-05 23:18:31",
"updated_at": "2019-06-05 23:18:31"
}
{
"id": 1,
"question_id": 1,
"user_id": 5,
"answer": "Definitely check to see if there are any MESA (Mathematics, Engineering, Science, Achievement) programs in your area. They have a lot of resources and volunteers who come to schools for this purpose!",
"created_at": "2019-06-05 23:18:31",
"updated_at": "2019-06-05 23:18:31"
}
{
"id": 1,
"topic": "Physics"
}
{
"id": 1,
"question_id": "1",
"topic_id": "1"
}
{
"id": 1,
"user_id": "5",
"topic_id": "1"
}
find(): returns all users in databasefindBy(filter): returns first user that matches filterfindById(id): returns single user by idfindUserQuestions(id): returns single user by id with array of questions and array of answers to questionsadd(user): adds new user to databaseremove(id): removes single user from databaseupdate(id, changes): updates a single user in database
find(): returns all questions in databasefindBy(id): returns single questions by idadd(question): adds new question to databaseremove(id): removes single question from databaseupdate(id, question): updates a single question in database
find(): returns all answers in databasefindBy(id): returns single answer by idadd(answer): adds new answer to databaseremove(id): removes single answer from databaseupdate(id, answer): updates a single answer in database
find(): returns all topics in databasefindBy(topic): returns id of passed in topicfindQuestionTopics(): returns all records in question_topics tableaddQuestionTopic(record): posts new record in question_topics tableaddExpertTopic(record): posts new record in expert_topics table
In order for the app to function correctly, the user must set up their own environment variables.
create a .env file that includes the following:
* STRIPE_SECRET_KEY - for stripe API
* dDB_ENV - set to "development" until ready for "production"
* dDATABASE_URL - for postgress Heroku deployment
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 Frontend Documentation for details on the fronend of our project.