-
Notifications
You must be signed in to change notification settings - Fork 512
Nella: Happy API #508
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nella-x
wants to merge
3
commits into
Technigo:master
Choose a base branch
from
nella-x:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Nella: Happy API #508
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| # Project Happy Thoughts API | ||
|
|
||
| Replace this readme with your own information about your project. | ||
|
|
||
| Start by briefly describing the assignment in a sentence or two. Keep it short and to the point. | ||
| This is the backend for the Happy Thoughts project, a simple API that enables users to share their positive thoughts and like thoughts posted by others. The goal is to create a functional and accessible API using modern web development technologies. | ||
|
|
||
| ## The problem | ||
|
|
||
| Describe how you approached to problem, and what tools and techniques you used to solve it. How did you plan? What technologies did you use? If you had more time, what would be next? | ||
| The goal of this project was to create an API that allows users to share positive thoughts and like others' posts. To achieve this, I used Express.js for server-side logic, MongoDB with Mongoose for data storage and validation, and dotenv for environment variables. The API includes endpoints to post new thoughts, fetch the 20 most recent thoughts, and like posts, with sorting and error handling to ensure a smooth experience. | ||
|
|
||
| ## View it live | ||
|
|
||
| Every project should be deployed somewhere. Be sure to include the link to the deployed project so that the viewer can click around and see what it's all about. | ||
| https://project-happy-thoughts-api-oq4w.onrender.com/ | ||
|
|
||
| check /endpoints for documentation |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,19 +6,103 @@ const mongoUrl = process.env.MONGO_URL || "mongodb://localhost/project-mongo"; | |
| mongoose.connect(mongoUrl); | ||
| mongoose.Promise = Promise; | ||
|
|
||
| // Defines the port the app will run on. Defaults to 8080, but can be overridden | ||
| // when starting the server. Example command to overwrite PORT env variable value: | ||
| // PORT=9000 npm start | ||
| const port = process.env.PORT || 8080; | ||
| const app = express(); | ||
|
|
||
| // Add middlewares to enable cors and json body parsing | ||
| app.use(cors()); | ||
| app.use(express.json()); | ||
|
|
||
| // Start defining your routes here | ||
| // Define the Thought model | ||
| const Thought = mongoose.model("Thought", { | ||
| message: { | ||
| type: String, | ||
| required: true, | ||
| minlength: 5, | ||
| maxlength: 140, | ||
| }, | ||
| hearts: { | ||
| type: Number, | ||
| default: 0, | ||
| }, | ||
| createdAt: { | ||
| type: Date, | ||
| default: () => new Date(), | ||
| }, | ||
| }); | ||
|
|
||
| // Default route | ||
| app.get("/", (req, res) => { | ||
| res.send("Hello Technigo!"); | ||
| res.send("Welcome to the Happy Thoughts API!"); | ||
| }); | ||
|
|
||
| // GET /thoughts - Fetch the 20 most recent thoughts | ||
| app.get("/thoughts", async (req, res) => { | ||
| try { | ||
| const thoughts = await Thought.find() | ||
| .sort({ createdAt: -1 }) // Sort by createdAt in descending order | ||
| .limit(20); // Limit to 20 results | ||
| res.status(200).json(thoughts); | ||
| } catch (err) { | ||
| res.status(400).json({ message: "Could not fetch thoughts", error: err }); | ||
| } | ||
| }); | ||
|
|
||
| // POST /thoughts - Create a new thought | ||
| app.post("/thoughts", async (req, res) => { | ||
| const { message } = req.body; | ||
|
|
||
| try { | ||
| const newThought = await new Thought({ message }).save(); | ||
| res.status(201).json(newThought); | ||
| } catch (err) { | ||
| res.status(400).json({ | ||
| message: "Could not save thought", | ||
| errors: err.errors | ||
| }); | ||
| } | ||
| }); | ||
|
|
||
| // POST /thoughts/:thoughtId/like - Add a heart to a thought | ||
| app.post("/thoughts/:thoughtId/like", async (req, res) => { | ||
| const { thoughtId } = req.params; | ||
|
|
||
| try { | ||
| const updatedThought = await Thought.findByIdAndUpdate( | ||
| thoughtId, | ||
| { $inc: { hearts: 1 } }, // Increment hearts by 1 | ||
| { new: true } // Return the updated document | ||
| ); | ||
|
|
||
| if (!updatedThought) { | ||
| res.status(404).json({ message: "Thought not found" }); | ||
| } else { | ||
| res.status(200).json(updatedThought); | ||
| } | ||
| } catch (err) { | ||
| res.status(400).json({ message: "Could not update hearts", error: err }); | ||
| } | ||
| }); | ||
|
|
||
| // GET /endpoints - Documentation | ||
| app.get("/endpoints", (req, res) => { | ||
| const apiDocumentation = [ | ||
| { | ||
| path: "/", | ||
| methods: ["GET"], | ||
| middleware: ["anonymous"], | ||
| }, | ||
| { | ||
| path: "/thoughts", | ||
| methods: ["GET", "POST"], | ||
| middleware: ["anonymous"], | ||
| }, | ||
| { | ||
| path: "/thoughts/:thoughtId/like", | ||
| methods: ["POST"], | ||
| middleware: ["anonymous"], | ||
| }, | ||
| ]; | ||
| res.status(200).json(apiDocumentation); | ||
|
Comment on lines
+86
to
+105
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
| }); | ||
|
|
||
| // Start the server | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
⭐