Add README, update links
This commit is contained in:
parent
4c00b3dd53
commit
7e137e96e7
4 changed files with 89 additions and 1 deletions
88
README.md
Normal file
88
README.md
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
<!-- PROJECT LOGO -->
|
||||
<br />
|
||||
<div align="center">
|
||||
<a href="https://github.com/rzmk/simple-blog">
|
||||
<img src="public/img/pencil.png" alt="Pencil" width="80" height="80">
|
||||
</a>
|
||||
|
||||
<h3 align="center">A Simple Blog</h3>
|
||||
<div align="center">
|
||||
<a href="https://rutgers-esports-mailing-list.herokuapp.com/"><strong>View the blog here! »</strong></a>
|
||||
<br />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<!-- TABLE OF CONTENTS -->
|
||||
<details open="open">
|
||||
<summary>Table of Contents</summary>
|
||||
<ol>
|
||||
<li>
|
||||
<a href="#about-the-project">About The Project</a>
|
||||
<ul>
|
||||
<li><a href="#built-with">Built With</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#contact">Contact</a></li>
|
||||
<li><a href="#acknowledgements">Acknowledgements</a></li>
|
||||
</ol>
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
<!-- ABOUT THE PROJECT -->
|
||||
## About The Project
|
||||
|
||||
<div align="center">
|
||||
<img src="public/img/screenshot.png" alt="Screenshot">
|
||||
</div>
|
||||
|
||||
A simple blog web application to learn full-stack web development.
|
||||
|
||||
Details
|
||||
* Developing based on the [Web Developer Bootcamp](https://www.udemy.com/share/1013gG/) course.
|
||||
* Using EJS for file organization and templating (components).
|
||||
* Learning much about SQL CRUD operations, schema, SQL databases (SQLlite), noSQL databases, and Mongoose ODM.
|
||||
* Connecting to a MongoDB database storing post info, with a hidden method on the blog site for creating new posts.
|
||||
|
||||
### Built With
|
||||
|
||||
* [Bootstrap](https://getbootstrap.com)
|
||||
* [Node.js](https://nodejs.org)
|
||||
* [Express](https://expressjs.com)
|
||||
* [Mongoose](https://mongoosejs.com/)
|
||||
* [EJS](https://ejs.co/)
|
||||
* [Heroku](https://www.heroku.com/)
|
||||
* [MongoDB](https://www.mongodb.com/)
|
||||
|
||||
|
||||
|
||||
<!-- CONTRIBUTING -->
|
||||
## Contributing
|
||||
|
||||
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
||||
|
||||
1. Fork the Project
|
||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
|
||||
<!-- CONTACT -->
|
||||
## Contact
|
||||
|
||||
Mueez Khan - [@mueezkhan_](https://twitter.com/mueezkhan_)
|
||||
|
||||
Project Link: [https://github.com/rzmk/simple-blog](https://github.com/rzmk/simple-blog)
|
||||
|
||||
|
||||
|
||||
<!-- ACKNOWLEDGEMENTS -->
|
||||
## Acknowledgements
|
||||
* [Lodash](https://lodash.com/)
|
||||
* [The Complete Web Development Bootcamp](https://www.udemy.com/share/1013gG/)
|
||||
* [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
|
||||
|
||||
|
||||
BIN
public/img/pencil.png
Normal file
BIN
public/img/pencil.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 322 B |
BIN
public/img/screenshot.png
Normal file
BIN
public/img/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
|
|
@ -2,5 +2,5 @@
|
|||
<h1>About</h1>
|
||||
<p> <%= aboutContent %> </p>
|
||||
<br />
|
||||
<p> <a href="#">Click here to see this project's details.</a> </p>
|
||||
<p> <a href="https://github.com/rzmk/simple-blog">Click here to see this project's details.</a> </p>
|
||||
<%- include("partials/footer"); -%>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue