generated from Technigo/express-api-starter
-
Notifications
You must be signed in to change notification settings - Fork 516
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
Happy Thoughts API Project - Elina Eriksson Hult #505
Open
ElinaEH
wants to merge
8
commits into
Technigo:master
Choose a base branch
from
ElinaEH: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
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ebc60f8
Installed dependencies and connected to MongoDB Atlas
ElinaEH 726de8d
Added mongoose schema and model
ElinaEH a4790c9
Created thoughts route and listEndpoints with express
ElinaEH d23514f
Created new thought route and like thought route
ElinaEH ddc692f
Clean up
ElinaEH b180389
Fixed express-list-endpoints typo and added content to readme file
ElinaEH a4ae965
Added render link to readme file and edited home route message
ElinaEH 77c5be6
Deleted console log for debugging
ElinaEH 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 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,8 @@ | ||
# 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 project is a Happy Thoughts Messaging API built with Express and MongoDB. It lets users create new thoughts, view the latest ones, and like a thought by adding hearts. I connected the project with my frontend Happy Thoughts project, enabling the API to handle requests and interact with the frontend. | ||
|
||
## 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? | ||
This project uses Express for the backend API, MongoDB with Mongoose for data storage, and dotenv for environment variable management. CORS handles cross-origin requests, and list-endpoints-express lists available API routes. I started with connecting the project to MongoDB Atlas and then built the required endpoints step by step. I made a small mistake when importing the express-list-endpoints, which caused my endpoints to appear incorrectly. After realizing the mistake, I was able to fix it and get the home route to display the endpoints in a structured order. | ||
|
||
## 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-pxns.onrender.com/ |
This file contains 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 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,24 +1,115 @@ | ||
import cors from "cors"; | ||
import express from "express"; | ||
import mongoose from "mongoose"; | ||
import dotenv from "dotenv"; | ||
import listEndpoints from "express-list-endpoints"; | ||
|
||
const mongoUrl = process.env.MONGO_URL || "mongodb://localhost/project-mongo"; | ||
mongoose.connect(mongoUrl); | ||
mongoose.Promise = Promise; | ||
// Load environment variables from env. file | ||
dotenv.config(); | ||
|
||
// 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 | ||
// Mongoose schema and model | ||
const thoughtSchema = new mongoose.Schema({ | ||
message: { | ||
type: String, | ||
required: true, | ||
minlength: 5, | ||
maxlength: 140 | ||
}, | ||
hearts: { | ||
type: Number, | ||
default: 0 | ||
}, | ||
createdAt: { | ||
type: Date, | ||
default: Date.now | ||
} | ||
}); | ||
|
||
const Thought = mongoose.model("Thought", thoughtSchema); | ||
|
||
// MongoDB connection setup | ||
const mongoUrl = process.env.MONGO_URI; | ||
|
||
mongoose.connect(mongoUrl) | ||
.then(() => { | ||
console.log('Connected to MongoDB Atlas'); | ||
}) | ||
.catch((error) => { | ||
console.error('Error connecting to MongoDB Atlas:', error); | ||
}); | ||
|
||
// Defines the port the app will run on, defaults to 8080 | ||
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 | ||
// Route definitions | ||
// Home route showing all endpoints | ||
app.get("/", (req, res) => { | ||
res.send("Hello Technigo!"); | ||
const endpoints = listEndpoints(app); // Automatically list all endpoints | ||
res.json({ | ||
message: "Hello and welcome to the Happy Thoughts API! Here are all the available endpoints:", | ||
endpoints: endpoints | ||
}); | ||
}); | ||
|
||
// Fetch all thoughts and show the latest 20 thoughts | ||
app.get("/thoughts", async (req, res) => { | ||
try { | ||
const thoughts = await Thought.find() | ||
.sort({ createdAt: -1 }) // Sort in descending order | ||
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.
this would be another way to do it |
||
.limit(20); // Limit to 20 results | ||
|
||
res.status(200).json(thoughts); // Return thoughts | ||
} catch (error) { | ||
res.status(400).json({ error: error.message }); // Handle error | ||
} | ||
}); | ||
|
||
// Create a new thought and save thought including id | ||
app.post("/thoughts", async (req, res) => { | ||
try { | ||
const { message } = req.body | ||
|
||
if (!message || typeof message !== "string") { | ||
return res.status(400).json({ error: "Invalid input. 'message' is required and must be a string" }); // Handle error | ||
} | ||
|
||
const thought = new Thought ({ message }); | ||
const savedThought = await thought.save(); | ||
|
||
console.log("New thought saved:", savedThought); | ||
res.status(201).json(savedThought); | ||
} catch (error) { | ||
console.error("Error saving thought:", error); | ||
res.status(500).json({ error: "An error occurred while saving the thought"}); // Handle error | ||
} | ||
}); | ||
|
||
// Like a thought and save the like | ||
app.post("/thoughts/:thoughtId/like", async (req, res) => { | ||
try { | ||
const { thoughtId } = req.params; | ||
|
||
const thought = await Thought.findByIdAndUpdate( | ||
thoughtId, | ||
{ $inc: { hearts: 1} }, | ||
{ new: true } | ||
); | ||
|
||
if (!thought) { | ||
return res.status(404).json({ error: "Thought not found." }); // No thought was found with this ID | ||
} | ||
|
||
// Respond with the updated thought | ||
res.status(200).json(thought); | ||
} catch (error) { | ||
console.error("Error updating hearts:", error.message); | ||
res.status(500).json({ error: "An error occurred while liking the thought." }) | ||
} | ||
}); | ||
|
||
// 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.
neat and structured