Skip to content

fdnd-agency/atlas4045

Repository files navigation


Logo

Atlas 40-45

4 Mei Comité Oosterparkbuurt
Live site »

Dev site · Project Board · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Importend data
  6. Team
  7. Acknowledgments

About The Project

Main page screenshot Overview page screenshot

This website functions as a supplement to the 'Gedenkposters' campaign of the 4 Mei Comité Oosterparkbuurt. Users can see an overview of all posters on display in the campaign, and see their location on a map. Features such as a filter function, and highlighted poster suggestions on the main page allow users to discover new stories and posters from the Oosterparkbuurt, and easily save or share these stories with others.

In the future, this website will house the stories of thousands of Jewish people from the Oosterparkbuurt who fell victim to the Holocaust, and allow people to discover their stories through an intuitive interface.

(back to top)

Built With

  • Svelte
  • Directus

(back to top)

Getting Started

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

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/fdnd-agency/atlas4045.git
  2. Install NPM packages
    npm install
  3. Create a .env file using example.env as a guide.
  4. Change git remote url to avoid accidental pushes to base project
    git remote set-url origin github_username/repo_name
    git remote -v # confirm the changes
  5. Run local dev server
    npm run dev

(back to top)

Contributing

Want to contribute as someone outside of the FDND organisation? Follow these steps:

  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

When contributing, make sure to follow the FDND Conventions »

Important data

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Team

  • Anna-Kyra Strik · Developer · Github »
  • Robin van der Heijden · Developer · Github »
  • Sarah Bouziane Bouziane · Designer · Github »
  • Cassidy Starke · Designer · Github »

(back to top)

Acknowledgments

(back to top)

Releases

No releases published

Contributors 4

  •  
  •  
  •  
  •