🌺🌺🌺🌺🌺🌺🌺🌺🌺🌺🌺🌺
Start up guide
-
Clone the repository to your local machine:
git clone https://github.com/fac28/SummerButterfly.git
-
Navigate to the project directory:
cd SummerButterfly -
Install project dependencies using npm:
npm install
-
Start the Node.js server:
node index.js
-
Open your web browser and visit http://localhost:8080
User Guide:
Welcome to Summer Butterfly. The site is deployed at this link https://summer-butterfly-846.fly.dev/ A key part of the summer experience is sharing how your summer is going so you can inspire everyone to take maximum advantage of the season!! For this purpose our home page has two forms, one where you type in your name (or your fun summer pseudonym if you prefer anonymity), and another form where you share your fun summer vibes with the world (in the form of words). Once you have filled these out, hit the post button to get your thoughts out there and participate in the season. If you are done posting and just want to look at what has been posted hit the show posts only button and if you change your mind and want to post again press the make new post button and you are back in business.
tldr to post fill the fields then click post. To change page click either show posts only or or make new post
User Story:
Our user Zoe D. hates how all the other blogging sites don't remind her of her favorite season. She wants a website that is fun and summer themed. She wants to see her posts and posts from her friends displayed in a fun summery fashion. Sometimes she wants to post but sometimes she wants to just take in the posts so her ideal website would have separate pages for posting and page viewing. Sometimes she slips up and sends a post that does not have summer vibes. She wants to be able to correct her mistake and take the post off the website. Sometimes her ex Joe G. L. makes annoying posts so if she can delete those too that's even better.
Dev Guide: The project can be cloned here https://github.com/fac28/SummerButterfly.git Automatic deployment is set up through fly so any pushes to main will be depolyed to the website. If you want to test changes by running locally use node index.js. The majority of the code that makes the site run is in index.js so that is a good starting point to start messing with the site. There is a test folder which containts some basic tests you can run to see the different server routes are running correctly. There is also a simple test of the sanitation to make sure the website is secure. The core function of this site is that there are two forms with buttons on the main page one which sends a post request which updates the content of the main page and the other which sends a get request to load a version of the page that is just posts.
🌺🌺🌺🌺🌺🌺🌺🌺🌺🌺🌺🌺