|
1 | | -# Eczease |
| 1 | +# EczEase |
2 | 2 |
|
3 | | -<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a> |
| 3 | +Eczema & Food Allergy Tech Solution |
4 | 4 |
|
5 | | -✨ Your new, shiny [Nx workspace](https://nx.dev) is almost ready ✨. |
| 5 | +## Roadmap |
6 | 6 |
|
7 | | -Run `npx nx graph` to visually explore what got created. Now, let's get you up to speed! |
| 7 | +This project involves developing a tech platform to support individuals with eczema and food allergies. The platform will include: |
8 | 8 |
|
9 | | -## Finish your CI setup |
| 9 | +- **AI Chatbot**: Provides personalized advice and guidance on managing eczema, focusing on diet and lifestyle adjustments. |
| 10 | +- **Symptom Tracking**: Users can log symptoms, food intake, and treatments to identify potential triggers and monitor progress. |
| 11 | +- **Naturopath Directory**: A global directory of naturopathic practitioners specializing in skin conditions, allowing users to find local experts. |
| 12 | +- **Educational Content**: Evidence-based articles and guides on eczema management, dietary interventions, and allergy awareness. |
| 13 | +- **Community Support**: Forums for users to share experiences and receive support from peers and experts. |
10 | 14 |
|
11 | | -[Click here to finish setting up your workspace!](https://cloud.nx.app/connect/6FXxgKbzPY) |
| 15 | +The goal is to empower users with actionable insights and resources to improve their condition while fostering a supportive community. |
12 | 16 |
|
| 17 | +## Contributing |
13 | 18 |
|
14 | | -## Run tasks |
| 19 | +We welcome contributions to the EczEase project! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests. |
15 | 20 |
|
16 | | -To run tasks with Nx use: |
| 21 | +## License |
17 | 22 |
|
18 | | -```sh |
19 | | -npx nx <target> <project-name> |
20 | | -``` |
21 | | - |
22 | | -For example: |
23 | | - |
24 | | -```sh |
25 | | -npx nx build myproject |
26 | | -``` |
27 | | - |
28 | | -These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or `package.json` files. |
29 | | - |
30 | | -[More about running tasks in the docs »](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) |
31 | | - |
32 | | -## Add new projects |
33 | | - |
34 | | -While you could add new projects to your workspace manually, you might want to leverage [Nx plugins](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) and their [code generation](https://nx.dev/features/generate-code?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) feature. |
35 | | - |
36 | | -To install a new plugin you can use the `nx add` command. Here's an example of adding the React plugin: |
37 | | -```sh |
38 | | -npx nx add @nx/react |
39 | | -``` |
40 | | - |
41 | | -Use the plugin's generator to create new projects. For example, to create a new React app or library: |
42 | | - |
43 | | -```sh |
44 | | -# Generate an app |
45 | | -npx nx g @nx/react:app demo |
46 | | - |
47 | | -# Generate a library |
48 | | -npx nx g @nx/react:lib some-lib |
49 | | -``` |
50 | | - |
51 | | -You can use `npx nx list` to get a list of installed plugins. Then, run `npx nx list <plugin-name>` to learn about more specific capabilities of a particular plugin. Alternatively, [install Nx Console](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) to browse plugins and generators in your IDE. |
52 | | - |
53 | | -[Learn more about Nx plugins »](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) | [Browse the plugin registry »](https://nx.dev/plugin-registry?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) |
54 | | - |
55 | | - |
56 | | -[Learn more about Nx on CI](https://nx.dev/ci/intro/ci-with-nx#ready-get-started-with-your-provider?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) |
57 | | - |
58 | | -## Install Nx Console |
59 | | - |
60 | | -Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ. |
61 | | - |
62 | | -[Install Nx Console »](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) |
63 | | - |
64 | | -## Useful links |
65 | | - |
66 | | -Learn more: |
67 | | - |
68 | | -- [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) |
69 | | -- [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) |
70 | | -- [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) |
71 | | - |
72 | | -And join the Nx community: |
73 | | -- [Discord](https://go.nx.dev/community) |
74 | | -- [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl) |
75 | | -- [Our Youtube channel](https://www.youtube.com/@nxdevtools) |
76 | | -- [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) |
| 23 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
0 commit comments