Contact App is a social network API that allows users to create, update, and manage their thougths. It features a robust backend built with Node.js, Express, and MongoDB, designed to handle API requests for managing user data and their thoughts and reactions to the thoughts.
- User creation, update, and deletion.
- Ability to add and manage user thoughts.
- Option to add and remove friends from a user's friend list.
- Ability to create and delete reactions to thoughts.
- Responsive and intuitive API endpoints.
BONUS
Additional feature: User deletion and associated thoughts with that user.
To install the Contact App on your local machine:
- Clone the repository to your local machine using
git clone
. - Navigate to the cloned directory and run
npm install
to install all required dependencies. - Ensure MongoDB is installed and running on your local machine.
- Seed the database
npm run seed
. - Start the application by running
npm start
.
To use Contact App:
- Make API requests to the provided endpoints to manage users, thoughts, friends, and reactions.
- Use tools like Postman or Insomnia for API testing and interaction.
- Deploy the application to Heroku for live usage (see deployment section).
- This is the link of my GitHub repository
- The following video of the app: technical acceptance/start server. GET routes all Users and all Thoughts, single User, single Thought Screencastify
- The following video of the app: POST, PUT, and DELETE routes for users and thoughts Screencastify
- The following video of the app: POST and DELETE routes for a userβs friend list Screencastify
- The following video of the app: POST and DELETE routes for reactions Screencastify
- The following
BONUS
video of the app: deletes a user's associated thoughts when the user is deleted Screencastify
Developed by [Kirill_Lazutin]
- Node.js
- Express
- MongoDB
- Mongoose
- NPM packages
To deploy on Heroku:
- Create a Heroku account and install the Heroku CLI.
- Log in to Heroku through the CLI and create a new Heroku app.
- Link your GitHub repository to the Heroku app.
- Set up your MongoDB database on a cloud platform like MongoDB Atlas and link it to your Heroku app.
- Deploy the app by pushing your code to the linked GitHub repository or directly through Heroku CLI.
Copyright (c) 2023 Kirill Lazutin
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.