search

cedricium / firefly

:fire: Vue.js / Express.js Fullstack Web Application
MIT License
3 stars 1 forks source link
bulma fullstack vue webapp

readme

Vue.js / Express.js Fullstack Web Application

Firefly is a fullstack web application clone of Awwwards, siteInspire, lapa, and Land-book who's purpose is to "shed light on inspiring sites from around the web". Firefly was a testbed for me to practice and gain experience using a JavaScript framework (Vue.js) as well as allowing me to further develop my general web development skills. As you may have guessed, Firefly is in fact named after the greatest sci-fi Western show in existence with the same name, Firefly.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer.

Installing

From your command line:

# Clone this repository
$ git clone https://github.com/cedricium/firefly

# Go into the repository
$ cd firefly/

# Install dependencies for the client (frontend)
$ cd client/ && npm install

# ... and for the server (backend)
$ cd ../server/ && npm install

# Run the app
$ npm run dev # client/ ==> Your application is running here: http://localhost:8080
$ npm start   # server/ ==> Server started on port: 8081

Deployment

Firefly will be able to be hosted on Heroku - check back later for instructions on deploying to Heroku.

Built With

Contributing

Your contributions are always welcome! See an issue you want to tackle or have an idea for a feature you'd like implemented? Just open a pull-request with a short explanation of the changes and I'd be happy to review it. :tada:

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments