Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jesusgraterol/maryluna

This website is the submission for The Odin Project: Homepage.
https://github.com/jesusgraterol/maryluna

theodinproject theodinproject-nodejs theodinprojectfoundations

Last synced: about 2 months ago
JSON representation

This website is the submission for The Odin Project: Homepage.

Awesome Lists containing this project

README

        

# Homepage

![Homepage](./readme-assets/screenshot-01.png)

This website is the submission for [The Odin Project: Homepage](https://www.theodinproject.com/lessons/node-path-advanced-html-and-css-homepage).

The key features are:

- Modern Layout
- Highly Accessible
- Optimized Build
- Cross-Platform Compatibility

## Live Demo

[Homepage](https://mar-y-luna.web.app/)

## Getting Started

### Requirements

- GIT
- NodeJS ^v21.0.0
- NPM ^v10.2.0
- Firebase CLI

### Installation

1) Clone the repository
```bash
git clone [email protected]:jesusgraterol/maryluna.git
```

2) Install the dependencies
```bash
npm install
```

## Usage

1) Serve the app with esbuild

```bash
npm run serve
```

2) Access it through: `http://localhost:9000/`

## Build Process

1) Run esbuild for production
```bash
npm run build
```

## Deployment

When a commit is pushed to the `main` branch, **Github Workflows** automatically pushes the new
distribution to **Firebase Hosting**.

## Built With

- HTML5
- CSS3
- JavaScript
- Jest
- esbuild

## Running the Tests

```bash
# Unit Tests
npm run test:unit

# Integration Tests
npm run test:integration

# E2E Tests
N/A
```

## @TODO

- Enable Multiple-Language Support

## License

[MIT](https://choosealicense.com/licenses/mit/)

## Acknowledgments

- [Google Fonts](https://fonts.google.com/icons)
- [ESLint](https://eslint.org/)
- [Jest](https://jestjs.io/)
- [Babel](https://babeljs.io/)
- [esbuild](https://esbuild.github.io/)
- [Firebase](https://firebase.google.com/)