Eclectic Carnival is an Express.js & Mongoose API back end for a social network.
Users can create thoughts and other users can post reactions to the thoughts. Users can add other users as friends. EC utilizes asynchronous JavaScript functions and performs CRUD functions (Create, Read, Update, and Delete) on users, thoughts, and reactions.
When a user deletes their account, all their thoughts are also deleted.
It uses Luxon to return formatted datetimes. Luxon is the chosen successor to Moment.js. See more here.
The app uses the Mongoose, Express, and Luxon Node.js packages.
AS A social media startup
I WANT an API for my social network that uses a NoSQL database
SO THAT my website can handle large amounts of unstructured data
AS A developer of a social media website
GIVEN a social network API
WHEN I enter the command to invoke the application
THEN my server is started and the Mongoose models are synced to the MongoDB database
WHEN I open API GET routes in Insomnia for users and thoughts
THEN the data for each of these routes is displayed in a formatted JSON
WHEN I test API POST, PUT, and DELETE routes in Insomnia
THEN I am able to successfully create, update, and delete users and thoughts in my database
WHEN I test API POST and DELETE routes in Insomnia
THEN I am able to successfully create and delete reactions to thoughts and add and remove friends to a user’s friend listTo start using Eclectic Carnival, first clone the repo to your server. Then run npm i to install all the dependent packages.
Next, open connection.js in the config folder. Supply your own MongoDB hostname and database name if applicable. Alternatively, create an environment variable in your hosting platform with the key MONGODB_URI and the hostname and database name of your MongoDb as the value.
Lastly, you may seed the database by running the command npm run seed. If you are using Heroku, the seed file will automatically run when the app build is complete. To remove this behavior, edit the package.json file to comment out or remove the key-value pair for key heroku-postbuild.
Open a terminal, navigate to the directory containing the index.js file, then run npm run start to start the app.
View these two videos for a demonstration of the API functionality:
This work is licensed under GNU General Publice License v3.0.
Visit the app's GitHub repo.
To reach me with additional questions, email me at mjamesd@gmail.com.