Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrianarivo/odin_intro_nodejs


https://github.com/andrianarivo/odin_intro_nodejs

Last synced: about 17 hours ago
JSON representation

Awesome Lists containing this project

README

        



Basic Informational Site

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Basic Informational Site

**Basic Informational Site** is a simple Node website!

## 🛠 Built With

### Tech Stack

Server

### Key Features

- **index page**
- **about page**
- **contact-me page**
- **404 page**

(back to top)

## 🚀 Live Demo

- [ReplIt](https://odinintronodejs.andrianarivo.repl.co)

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- `NodeJS`
- `Code editor`

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/andrianarivo/odin_intro_nodejs
```

### Install

Install this project with:

```sh
cd odin_intro_nodejs
npm i
```

### Usage

To run the project, execute the following command:

```sh
DEBUG=basicsite:* npm start
```

### Deployment

You can deploy this project using your own deployment server.

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **David**

- GitHub: [@andrianarivo](https://github.com/andrianarivo)
- Twitter: [@dandrianarivo](https://twitter.com/dandrianarivo)
- LinkedIn: [LinkedIn](https://linkedin.com/in/andrianarivo)

(back to top)

## 🔭 Future Features

- [ ] **ESLint**
- [ ] **Unit tests**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project consider adding a ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank the Odin Project

(back to top)

## 📝 License

This project is [MIT](./MIT.md) licensed.

(back to top)