Code Monkey home page Code Monkey logo

memories's Introduction

Memories

A social platform to share your worldwide memories.

Build Status David Code Climate Physical Web Liquid Galaxy

Live

Live @ geographical-memories.firebaseapp.com

Getting started

Want to run this project yourself?

Requirements:

Edit src/environments/environment.prod.ts to suit your needs. The current configuration is the one used at https://geographical-memories.firebaseapp.com

export const environment = {
  production: true,
  firebase: {
    // Inside a Firebase project, they will provide you with all this information at once.
    // Overview -> Add Firebase to your web app.
    apiKey: 'AIzaSyC84AqlQQSAJQxvdkJ_U6EGw6TTQpV-PBA',
    authDomain: 'geographical-memories.firebaseapp.com',
    databaseURL: 'https://geographical-memories.firebaseio.com',
    projectId: 'geographical-memories',
    storageBucket: 'geographical-memories.appspot.com',
    messagingSenderId: '1078012876993',
  },
  maps: {
    // https://developers.google.com/maps/documentation/javascript/get-api-key
    apiKey: 'AIzaSyDB8v_lXYf4FGzrv5gmJvUaZaDRfck2QbE',
  },
  urlShortener: {
    // https://developers.google.com/url-shortener/v1/getting_started
    apiKey: 'AIzaSyBNGykVSDx3ZNdGnlZU1wne2eT3uAkywiU',
  }
};

Install project dependencies first with npm install.

Build the project with npm run build.

Serve the built project yourself or upload the dist/ project onto the Firebase hosting.

Either if you are serving the project yourself or uploading it onto the Firebase hosting, you do need to modify the .firebaserc file to match the name of your own Firebase project. That is because the database and storage rules do still have to be uploaded to Firebase (unless you are doing this process manually by copy-pasting the contents in firebase/database.rules.json).

To have everything uploaded inside Firebase, install Firebase Tools first.

npm install -g firebase-tools

Afterwards, run:

firebase deploy

Your own Geographical Memories version should now be live!

Built with

Core technologies/dependencies:

Development

Want to help with the development of Geographical Memories?

Requirements:

  • Node 8+
  • Firebase project to test your modifications on a non-production environment (create one here)

Edit src/environments/environment.ts to suit your needs.

Install dependencies with npm install and run the project as development with npm start. Make sure to run a full set of tests with npm test before commiting!

We are following https://github.com/gothinkster/angular-realworld-example-app when it comes to the application coding structure and style.

It is to note that we are also using a CoreModule to store our servies, to prevent what should be singletons from reinitializating themselves when splitting the bundle.js into chunks.

Contributions

Contributions are welcome. See Development.

License

MIT © Gerard Rovira Sánchez

Google Summer of Code

memories's People

Contributors

angular-cli avatar zurfyx avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.