Memorable Words App

A statically-deployed web app to enable the collaborative review of word lists.

Development

Components library

This app is configured to use of a library of components that is maintained separately. You must make sure it is available before installing the dependencies.

# Clone the components library nex to this app (the path matters):
git clone [email protected]:memorablewords/svelte-components.git ../svelte-components

Once the components library is available at ../svelte-components, it will be installed with the rest of the dependencies.

Install the dependencies

Install the dependencies…

cd app
npm install

…then start Rollup:

npm run dev

Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

Building and running in production mode

To create an optimized version of the app:

make build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Deployment

Install surge if you haven't already:

npm install -g surge

Then, from within the app folder:

git checkout main && git pull origin main
make release record-release # will build the app and create and record a new release
make deploy # will deploy the new release
git push origin main

Contributing

I'm learning to work with Svelte on this project, and I'm using it to practice setting up an application and identifying trade-offs. I'm sure there are better ways to do may things in this code and I'd love to hear your thoughts if you mind sharing them!

Opening an issue is a good way to get in touch, but if you're not a Github user, writing to [email protected] is a good way too.

Please note that by participating in this project, you agree to abide by its code of conduct. That is true for pull requests, emails, and also when participating in issues.

Credits

Most of the project icons are Feather icons, created by @colebemis and published under the MIT License. The other icons are inspired by them!

The application code also depends on several projects from the Svelte ecosystem, in particular svelte-i18n and @ashour accompanying blog post made my day.

The design owes to Amanda Sepúlveda Brajovic, as does the management of the project.

Here and there, credits are given in the code, huge thanks to everyone!

License

Memorable Words App
Copyright (C) 2020 Gonzalo Bulnes Guilpain

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.